plotly.py-docs/generated/plotly.express.imshow.html at debug · plotly/plotly.py-docs

History

223 lines (192 loc) · 14.1 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

<!DOCTYPE html>

<head>

<title>plotly.express.imshow — 4.6.0 documentation</title>

</head><body>

</button>

</a>

</div>

<a role="button"

id="dLabelGlobalToc"

data-toggle="dropdown"

data-target="#"

href="../index.html">Site </a>

<ul class="dropdown-menu globaltoc"

role="menu"

aria-labelledby="dLabelGlobalToc"><ul class="current">

<li class="toctree-l1 current"><a class="reference internal" href="../plotly.express.html"><code class="docutils literal notranslate">plotly.express</code>: high-level interface for data visualization</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.graph_objects.html"><code class="docutils literal notranslate">plotly.graph_objects</code>: low-level interface to figures, traces and layout</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.subplots.html"><code class="docutils literal notranslate">plotly.subplots</code>: helper function for laying out multi-plot figures</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.figure_factory.html"><code class="docutils literal notranslate">plotly.figure_factory</code>: helper methods for building specific complex charts</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.io.html"><code class="docutils literal notranslate">plotly.io</code>: low-level interface for displaying, reading and writing figures</a></li>

</ul>

</li>

<a role="button"

id="dLabelLocalToc"

data-toggle="dropdown"

data-target="#"

href="#">Page </a>

<ul class="dropdown-menu localtoc"

role="menu"

aria-labelledby="dLabelLocalToc"><ul>

<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">plotly.express</code>.imshow</a></li>

</ul>

</li>

<li>

<a href="plotly.express.density_mapbox.html" title="Previous Chapter: plotly.express.density_mapbox">« plotly.expres...

</a>

</li>

<li>

<a href="../plotly.graph_objects.html" title="Next Chapter: plotly.graph_objects: low-level interface to figures, traces and layout">plotly.graph_... »

</a>

</li>

</ul>

</div>

</form>

</div>

<h1><a class="reference internal" href="plotly.express.html#module-plotly.express" title="plotly.express"><code class="xref py py-mod docutils literal notranslate">plotly.express</code></a>.imshow<a class="headerlink" href="#plotly-express-imshow" title="Permalink to this headline">¶</a></h1>

<code class="sig-prename descclassname">plotly.express.</code><code class="sig-name descname">imshow</code>(img, zmin=None, zmax=None, origin=None, labels={}, x=None, y=None, color_continuous_scale=None, color_continuous_midpoint=None, range_color=None, title=None, template=None, width=None, height=None, aspect=None)<a class="headerlink" href="#plotly.express.imshow" title="Permalink to this definition">¶</a></dt>

<dd>Display an image, i.e. data on a 2D regular raster.

<dt class="field-odd">Parameters</dt>

<li>img (array-like image, or xarray) – The image data. Supported array shapes are

<ul>

<li>(M, N): an image with scalar data. The data is visualized

using a colormap.</li>

<li>(M, N, 3): an image with RGB values.</li>

<li>(M, N, 4): an image with RGBA values, i.e. including transparency.</li>

</ul>

</li>

<li>zmax (zmin,) – zmin and zmax define the scalar range that the colormap covers. By default,

zmin and zmax correspond to the min and max values of the datatype for integer

datatypes (ie [0-255] for uint8 images, [0, 65535] for uint16 images, etc.). For

a multichannel image of floats, the max of the image is computed and zmax is the

smallest power of 256 (1, 255, 65535) greater than this max value,

with a 5% tolerance. For a single-channel image, the max of the image is used.

Overridden by range_color.</li>

<li>origin (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a>, 'upper' or 'lower' (default 'upper')) – position of the [0, 0] pixel of the image array, in the upper left or lower left

corner. The convention ‘upper’ is typically used for matrices and images.</li>

<li>labels (dict with str keys and str values (default <code class="docutils literal notranslate">{}</code>)) – Sets names used in the figure for axis titles (keys <code class="docutils literal notranslate">x</code> and <code class="docutils literal notranslate">y</code>),

colorbar title and hoverlabel (key <code class="docutils literal notranslate">color</code>). The values should correspond

to the desired label to be displayed. If <code class="docutils literal notranslate">img</code> is an xarray, dimension

names are used for axis titles, and long name for the colorbar title

(unless overridden in <code class="docutils literal notranslate">labels</code>). Possible keys are: x, y, and color.</li>

<li>y (x,) – x and y are used to label the axes of single-channel heatmap visualizations and

their lengths must match the lengths of the second and first dimensions of the

img argument. They are auto-populated if the input is an xarray.</li>

<li>color_continuous_scale (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or list of str) – colormap used to map scalar data to colors (for a 2D image). This parameter is

not used for RGB or RGBA images. If a string is provided, it should be the name

of a known color scale, and if a list is provided, it should be a list of CSS-

compatible colors.</li>

<li>color_continuous_midpoint (number) – If set, computes the bounds of the continuous color scale to have the desired

midpoint. Overridden by range_color or zmin and zmax.</li>

<li>range_color (list of two numbers) – If provided, overrides auto-scaling on the continuous color scale, including

overriding <code class="docutils literal notranslate">color_continuous_midpoint</code>. Also overrides zmin and zmax. Used only

for single-channel images.</li>

<li>title (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a>) – The figure title.</li>

<li>template (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.8)">dict</a> or plotly.graph_objects.layout.Template instance) – The figure template name or definition.</li>

<li>width (number) – The figure width in pixels.</li>

<li>height (number) – The figure height in pixels.</li>

<li>aspect ('equal', 'auto', or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)">None</a>) – <ul>

<li>‘equal’: Ensures an aspect ratio of 1 or pixels (square pixels)</li>

<li>’auto’: The axes is kept fixed and the aspect ratio of pixels is

adjusted so that the data fit in the axes. In general, this will

result in non-square pixels.</li>

<li>if None, ‘equal’ is used for numpy arrays and ‘auto’ for xarrays

(which have typically heterogeneous coordinates)</li>

</ul>

</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

<dd class="field-even">fig

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd">graph_objects.Figure containing the displayed image

</dd>

</dl>

See also

<dt><a class="reference internal" href="plotly.graph_objects.html#plotly.graph_objects.Image" title="plotly.graph_objects.Image"><code class="xref py py-func docutils literal notranslate">plotly.graph_objects.Image()</code></a></dt><dd>image trace

</dd>

<dt><a class="reference internal" href="plotly.graph_objects.html#plotly.graph_objects.Heatmap" title="plotly.graph_objects.Heatmap"><code class="xref py py-func docutils literal notranslate">plotly.graph_objects.Heatmap()</code></a></dt><dd>heatmap trace

</dd>

</dl>

</div>

Notes

In order to update and customize the returned figure, use

<code class="docutils literal notranslate">go.Figure.update_traces</code> or <code class="docutils literal notranslate">go.Figure.update_layout</code>.

If an xarray is passed, dimensions names and coordinates are used for

axes labels and ticks.

</dd></dl>

</div>

var _gaq = _gaq || [];

_gaq.push(['_setAccount', 'UA-39373211-1']);

_gaq.push(['_setDomainName', 'none']);

_gaq.push(['_setAllowLinker', true]);

_gaq.push(['_trackPageview']);

(function() {

var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

})();

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

plotly.express.imshow.html

Latest commit

History

plotly.express.imshow.html

File metadata and controls