matplotlib.github.com/3.4.1/_modules/matplotlib/category.html at main · ACPMAD/matplotlib.github.com

History

371 lines (311 loc) · 32.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

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.category — Matplotlib 3.4.1 documentation</title>

title="Search within Matplotlib 3.4.1 documentation"

href="../../_static/opensearch.xml"/>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.1). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.4.1</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<ul>

<li><a href="../../users/installing.html">Installation</a></li>

<li><a href="../../contents.html">Documentation</a></li>

<li><a href="../../gallery/index.html">Examples</a></li>

<li><a href="../../tutorials/index.html">Tutorials</a></li>

<li><a href="../../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li><a href="../../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

<li class="nav-item nav-item-this"><a href="">matplotlib.category</a></li>

</ul>

</div>

</div>

<h1>Source code for matplotlib.category</h1><div class="highlight"><pre>

"""

Plotting of string "category" data: ``plot(['d', 'f', 'a'], [1, 2, 3])`` will

plot three points with x-axis values of 'd', 'f', 'a'.

See :doc:`/gallery/lines_bars_and_markers/categorical_variables` for an

example.

The module uses Matplotlib's `matplotlib.units` mechanism to convert from

strings to integers and provides a tick locator, a tick formatter, and the

`.UnitData` class that creates and stores the string-to-integer mapping.

"""

from collections import OrderedDict

import dateutil.parser

import itertools

import logging

import numpy as np

from matplotlib import _api, ticker, units

_log = logging.getLogger(__name__)

<div class="viewcode-block" id="StrCategoryConverter"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.StrCategoryConverter">[docs]</a>class StrCategoryConverter(units.ConversionInterface):

<div class="viewcode-block" id="StrCategoryConverter.convert"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.StrCategoryConverter.convert">[docs]</a> @staticmethod

def convert(value, unit, axis):

"""

Convert strings in *value* to floats using mapping information stored

in the *unit* object.

Parameters

----------

value : str or iterable

Value or list of values to be converted.

unit : `.UnitData`

An object mapping strings to integers.

axis : `~matplotlib.axis.Axis`

The axis on which the converted value is plotted.

.. note:: *axis* is unused.

Returns

-------

float or ndarray[float]

"""

if unit is None:

raise ValueError(

'Missing category information for StrCategoryConverter; '

'this might be caused by unintendedly mixing categorical and '

'numeric data')

StrCategoryConverter._validate_unit(unit)

# dtype = object preserves numerical pass throughs

values = np.atleast_1d(np.array(value, dtype=object))

# pass through sequence of non binary numbers

if all(units.ConversionInterface.is_numlike(v)

and not isinstance(v, (str, bytes))

for v in values):

return np.asarray(values, dtype=float)

# force an update so it also does type checking

unit.update(values)

return np.vectorize(unit._mapping.__getitem__, otypes=[float])(values)</div>

<div class="viewcode-block" id="StrCategoryConverter.axisinfo"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.StrCategoryConverter.axisinfo">[docs]</a> @staticmethod

def axisinfo(unit, axis):

"""

Set the default axis ticks and labels.

Parameters

----------

unit : `.UnitData`

object string unit information for value

axis : `~matplotlib.axis.Axis`

axis for which information is being set

Returns

-------

`~matplotlib.units.AxisInfo`

Information to support default tick labeling

.. note: axis is not used

"""

StrCategoryConverter._validate_unit(unit)

# locator and formatter take mapping dict because

# args need to be pass by reference for updates

majloc = StrCategoryLocator(unit._mapping)

majfmt = StrCategoryFormatter(unit._mapping)

return units.AxisInfo(majloc=majloc, majfmt=majfmt)</div>

<div class="viewcode-block" id="StrCategoryConverter.default_units"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.StrCategoryConverter.default_units">[docs]</a> @staticmethod

def default_units(data, axis):

"""

Set and update the `~matplotlib.axis.Axis` units.

Parameters

----------

data : str or iterable of str

axis : `~matplotlib.axis.Axis`

axis on which the data is plotted

Returns

-------

`.UnitData`

object storing string to integer mapping

"""

# the conversion call stack is default_units -> axis_info -> convert

if axis.units is None:

axis.set_units(UnitData(data))

else:

axis.units.update(data)

return axis.units</div>

@staticmethod

def _validate_unit(unit):

if not hasattr(unit, '_mapping'):

raise ValueError(

f'Provided unit "{unit}" is not valid for a categorical '

'converter, as it does not have a _mapping attribute.')</div>

<div class="viewcode-block" id="StrCategoryLocator"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.StrCategoryLocator">[docs]</a>class StrCategoryLocator(ticker.Locator):

"""Tick at every integer mapping of the string data."""

def __init__(self, units_mapping):

"""

Parameters

-----------

units_mapping : dict

Mapping of category names (str) to indices (int).

"""

self._units = units_mapping

def __call__(self):

# docstring inherited

return list(self._units.values())

<div class="viewcode-block" id="StrCategoryLocator.tick_values"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.StrCategoryLocator.tick_values">[docs]</a> def tick_values(self, vmin, vmax):

# docstring inherited

return self()</div></div>

<div class="viewcode-block" id="StrCategoryFormatter"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.StrCategoryFormatter">[docs]</a>class StrCategoryFormatter(ticker.Formatter):

"""String representation of the data at every tick."""

def __init__(self, units_mapping):

"""

Parameters

----------

units_mapping : dict

Mapping of category names (str) to indices (int).

"""

self._units = units_mapping

def __call__(self, x, pos=None):

# docstring inherited

return self.format_ticks([x])[0]

<div class="viewcode-block" id="StrCategoryFormatter.format_ticks"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.StrCategoryFormatter.format_ticks">[docs]</a> def format_ticks(self, values):

# docstring inherited

r_mapping = {v: self._text(k) for k, v in self._units.items()}

return [r_mapping.get(round(val), '') for val in values]</div>

@staticmethod

def _text(value):

"""Convert text values into utf-8 or ascii strings."""

if isinstance(value, bytes):

value = value.decode(encoding='utf-8')

elif not isinstance(value, str):

value = str(value)

return value</div>

<div class="viewcode-block" id="UnitData"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.UnitData">[docs]</a>class UnitData:

def __init__(self, data=None):

"""

Create mapping between unique categorical values and integer ids.

Parameters

----------

data : iterable

sequence of string values

"""

self._mapping = OrderedDict()

self._counter = itertools.count()

if data is not None:

self.update(data)

@staticmethod

def _str_is_convertible(val):

"""

Helper method to check whether a string can be parsed as float or date.

"""

try:

float(val)

except ValueError:

try:

dateutil.parser.parse(val)

except (ValueError, TypeError):

# TypeError if dateutil >= 2.8.1 else ValueError

return False

return True

<div class="viewcode-block" id="UnitData.update"><a class="viewcode-back" href="../../api/category_api.html#matplotlib.category.UnitData.update">[docs]</a> def update(self, data):

"""

Map new values to integer identifiers.

Parameters

----------

data : iterable of str or bytes

Raises

------

TypeError

If elements in *data* are neither str nor bytes.

"""

data = np.atleast_1d(np.array(data, dtype=object))

# check if convertible to number:

convertible = True

for val in OrderedDict.fromkeys(data):

# OrderedDict just iterates over unique values in data.

_api.check_isinstance((str, bytes), value=val)

if convertible:

# this will only be called so long as convertible is True.

convertible = self._str_is_convertible(val)

if val not in self._mapping:

self._mapping[val] = next(self._counter)

if convertible:

_log.info('Using categorical units to plot a list of strings '

'that are all parsable as floats or dates. If these '

'strings should be plotted as numbers, cast to the '

'appropriate data type before plotting.')</div></div>

# Register the converter with Matplotlib's unit framework

units.registry[str] = StrCategoryConverter()

units.registry[np.str_] = StrCategoryConverter()

units.registry[bytes] = StrCategoryConverter()

units.registry[np.bytes_] = StrCategoryConverter()

</pre></div>

</div>

</div>

Last updated on Mar 31, 2021.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.

Doc version v3.4.1-3-gc6d08c6a8b-dirty.

</div>

</footer>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

category.html

Latest commit

History

category.html

File metadata and controls