Describe the bug
A clear and concise description of what the bug is.
To Reproduce
I'm finding that, when using a set of custom bins within a colormap, the color palette generated with to_step() differs from that created via StepColormap(), even though both of these methods produce the same palette when custom bins are not requested.
Code that demonstrates this discrepancy can be found within this notebook.
Expected behavior
I would expect that the color palettes generated via the following code would be the same: (I recognize that the range represented by each color will change due to the use of custom bins, but I was expecting the actual colors to remain unmodified).
Method 1:
linear_to_step = linear.RdYlBu_10.to_step(n = 10)
Output:
![image](https://private-user-images.githubusercontent.com/32693822/333808588-33b311c3-8e1f-4f70-9357-cd316626d44d.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjE0NDI3NzAsIm5iZiI6MTcyMTQ0MjQ3MCwicGF0aCI6Ii8zMjY5MzgyMi8zMzM4MDg1ODgtMzNiMzExYzMtOGUxZi00ZjcwLTkzNTctY2QzMTY2MjZkNDRkLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzIwVDAyMjc1MFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWIwMzgxNmFmNmI5MDI0ODhkMjU1NDdhZjBjY2E0NjE1Yzk4ZGE0MGI4ZDJkYmVmOGM5ZjBlMjY1ZTNjZThlNTAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.n3QnV1AV_qU5Fm2qVStf4xdqFb0UjAbx5x85nm-vEgw)
Method 2:
bins = [-26.57727350868145,
-2.8124548451811697,
-1.3842847014410304,
-0.57942086570913,
0.10509734758955473,
0.803350933220706,
1.5648502030833924,
2.497913057064161,
3.8660584451404807,
5.966706571952004,
25.59683979436641]
custom_bins_to_step = linear.RdYlBu_10.to_step(index = bins)
Output:
![image](https://private-user-images.githubusercontent.com/32693822/333808428-31903fb4-1caf-4d9f-b13f-b70add3f8907.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjE0NDI3NzAsIm5iZiI6MTcyMTQ0MjQ3MCwicGF0aCI6Ii8zMjY5MzgyMi8zMzM4MDg0MjgtMzE5MDNmYjQtMWNhZi00ZDlmLWIxM2YtYjcwYWRkM2Y4OTA3LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzIwVDAyMjc1MFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWU4NGU4ZDQ2YTcyNTIzMzVkYjgyZTY4MjE1NDk1Y2NhYzZmMjI2ZTc0NjU4MTRlMjk5YjYwYWVkYzU0YzFiYTYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.Vsmq3kbRXXMSxuA35MGfVECeDbZA86jUk0dL_BjPLBo)
Note that, when the second method is used, the interior colors within the color palette get much lighter, though the first and last colors are the same. (See the notebook I linked to earlier for a list of the colors.)
Meanwhile, the following methods that use StepColormap produce the same palettes:
Method 1:
color_range = color_brewer('RdYlBu', n = 10)
linear_stepcolormap = StepColormap(colors = color_range)
Output:
![image](https://private-user-images.githubusercontent.com/32693822/333808608-5bccc050-5822-492f-ac15-349020d01b03.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjE0NDI3NzAsIm5iZiI6MTcyMTQ0MjQ3MCwicGF0aCI6Ii8zMjY5MzgyMi8zMzM4MDg2MDgtNWJjY2MwNTAtNTgyMi00OTJmLWFjMTUtMzQ5MDIwZDAxYjAzLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzIwVDAyMjc1MFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTZlMzY2NTQ1MDg3NmRlYTk5ZWNiYmM0OTVmYTc3MzFmMzkzOTBlOWZhNjNhOTBjOWJmNWVhMzRlNDgyODVmNjcmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.2F2f217nbK2CDppLEqFqJfblXmzQJuj521pGF-7Otg0)
Method 2 (using previously defined color_range
and bins
values):
custom_bins_stepcolormap = StepColormap(
colors = color_range,
vmin = bins[0], vmax = bins[-1],
index = bins)
Output:
![image](https://private-user-images.githubusercontent.com/32693822/333808501-607453af-701f-4d10-bc56-5f438cdb5cdc.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjE0NDI3NzAsIm5iZiI6MTcyMTQ0MjQ3MCwicGF0aCI6Ii8zMjY5MzgyMi8zMzM4MDg1MDEtNjA3NDUzYWYtNzAxZi00ZDEwLWJjNTYtNWY0MzhjZGI1Y2RjLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzIwVDAyMjc1MFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTJhM2VjOWI1OTFhZDkxNTNkODkzNGQzMzkyOWU1ZTMyYmU0NTRhNzlmNDkyM2NiMzE2MTZjNDk4MzNkMWU2ZGQmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.1xAsC_Z3QvYnkaLw5rY1UIEG-C4-GJs8DPjmJvO22pY)
I'm not sure whether this is a bug or if I'm misunderstanding how the to_step() method works, but either way, your help in getting to_step() to produce the same color palette with custom bins that it does without custom bins would be greatly appreciated. I would also be happy to test out any potential fixes/solutions.
Environment:
- Browser [e.g. chrome, firefox]: Running this code via JupyterLab Desktop and Visual Studio Code. Currently writing this on Chrome
- Jupyter Notebook or html files? Jupyter Notebook
- Python version: 3.12.3
- folium version: 0.16.0
- branca version: 0.7.2
Additional context
When custom_bins_to_step and custom_bins_stepcolormap are fed into the same custom choropleth mapping function, they produce very different results:
Map created with custom_bins_stepcolormap:
![image](https://private-user-images.githubusercontent.com/32693822/333808066-77148bef-83c5-4ab1-baaa-cf25af5ad538.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjE0NDI3NzAsIm5iZiI6MTcyMTQ0MjQ3MCwicGF0aCI6Ii8zMjY5MzgyMi8zMzM4MDgwNjYtNzcxNDhiZWYtODNjNS00YWIxLWJhYWEtY2YyNWFmNWFkNTM4LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzIwVDAyMjc1MFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWQ2ZWFiOGNjNzMwZDhhZDM1MjczMzUxYWJkZmMwNDkwZDQwMmFhM2U5NjMyMGVkOTE0MDgwOWI4NzZkYjQ1NjYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.5PvDwKp0DhBF5VjFUS2QUf7gCOv5eCB-I_-wWGy9VYw)
The colors in the above map match those I'm seeing from a folium.Choropleth() call.
Map created with custom_bins_to_step):
![image](https://private-user-images.githubusercontent.com/32693822/333808183-babf1178-5d2e-4df4-a14e-96c4c87afb6e.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjE0NDI3NzAsIm5iZiI6MTcyMTQ0MjQ3MCwicGF0aCI6Ii8zMjY5MzgyMi8zMzM4MDgxODMtYmFiZjExNzgtNWQyZS00ZGY0LWExNGUtOTZjNGM4N2FmYjZlLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzIwVDAyMjc1MFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTBiMjAyMDY2NmUxYjE5MzhkOWUyN2QxOTgzMGY3Y2ZkMzdlOTFhODYyZjg3NTI3ZWYyNGVlMWZjY2U2OTBmMWUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0._PbwsPgtHkUq1m5-g-50mx7Vo6yl0R60Pm-U3Rg1-1M)