@@ -2264,7 +2264,7 @@ def __init__(self): |
2264 | 2264 | """ |
2265 | 2265 | Abstract base class for normalizations. |
2266 | 2266 |
|
2267 | | - Subclasses include `colors.Normalize` which maps from a scalar to |
| 2267 | + Subclasses include `Normalize` which maps from a scalar to |
2268 | 2268 | a scalar. However, this class makes no such requirement, and subclasses may |
2269 | 2269 | support the normalization of multiple variates simultaneously, with |
2270 | 2270 | separate normalization for each variate. |
@@ -2311,7 +2311,6 @@ def __call__(self, value, clip=None): |
2311 | 2311 | Notes |
2312 | 2312 | ----- |
2313 | 2313 | If not already initialized, ``self.vmin`` and ``self.vmax`` are |
2314 | | -
|
2315 | 2314 | initialized using ``self.autoscale_None(value)``. |
2316 | 2315 | """ |
2317 | 2316 | pass |
@@ -2410,7 +2409,7 @@ def __init__(self, vmin=None, vmax=None, clip=False): |
2410 | 2409 |
|
2411 | 2410 | @property |
2412 | 2411 | def vmin(self): |
2413 | | - """Lower limit of the input data interval; maps to 0.""" |
| 2412 | + # docstring inherited |
2414 | 2413 | return self._vmin |
2415 | 2414 |
|
2416 | 2415 | @vmin.setter |
@@ -2422,7 +2421,7 @@ def vmin(self, value): |
2422 | 2421 |
|
2423 | 2422 | @property |
2424 | 2423 | def vmax(self): |
2425 | | - """Upper limit of the input data interval; maps to 1.""" |
| 2424 | + # docstring inherited |
2426 | 2425 | return self._vmax |
2427 | 2426 |
|
2428 | 2427 | @vmax.setter |
@@ -2434,11 +2433,7 @@ def vmax(self, value): |
2434 | 2433 |
|
2435 | 2434 | @property |
2436 | 2435 | def clip(self): |
2437 | | - """ |
2438 | | - Determines the behavior for mapping values outside the range ``[vmin, vmax]``. |
2439 | | -
|
2440 | | - See the *clip* parameter in `.Normalize`. |
2441 | | - """ |
| 2436 | + # docstring inherited |
2442 | 2437 | return self._clip |
2443 | 2438 |
|
2444 | 2439 | @clip.setter |
@@ -2488,24 +2483,7 @@ def process_value(value): |
2488 | 2483 | return result, is_scalar |
2489 | 2484 |
|
2490 | 2485 | def __call__(self, value, clip=None): |
2491 | | - """ |
2492 | | - Normalize the data and return the normalized data. |
2493 | | -
|
2494 | | - Parameters |
2495 | | - ---------- |
2496 | | - value |
2497 | | - Data to normalize. |
2498 | | - clip : bool, optional |
2499 | | - See the description of the parameter *clip* in `.Normalize`. |
2500 | | -
|
2501 | | - If ``None``, defaults to ``self.clip`` (which defaults to |
2502 | | - ``False``). |
2503 | | -
|
2504 | | - Notes |
2505 | | - ----- |
2506 | | - If not already initialized, ``self.vmin`` and ``self.vmax`` are |
2507 | | - initialized using ``self.autoscale_None(value)``. |
2508 | | - """ |
| 2486 | + # docstring inherited |
2509 | 2487 | if clip is None: |
2510 | 2488 | clip = self.clip |
2511 | 2489 |
|
@@ -2535,15 +2513,7 @@ def __call__(self, value, clip=None): |
2535 | 2513 | return result |
2536 | 2514 |
|
2537 | 2515 | def inverse(self, value): |
2538 | | - """ |
2539 | | - Maps the normalized value (i.e., index in the colormap) back to image |
2540 | | - data value. |
2541 | | -
|
2542 | | - Parameters |
2543 | | - ---------- |
2544 | | - value |
2545 | | - Normalized value. |
2546 | | - """ |
| 2516 | + # docstring inherited |
2547 | 2517 | if not self.scaled(): |
2548 | 2518 | raise ValueError("Not invertible until both vmin and vmax are set") |
2549 | 2519 | (vmin,), _ = self.process_value(self.vmin) |
@@ -2556,7 +2526,7 @@ def inverse(self, value): |
2556 | 2526 | return vmin + value * (vmax - vmin) |
2557 | 2527 |
|
2558 | 2528 | def autoscale(self, A): |
2559 | | - """Set *vmin*, *vmax* to min, max of *A*.""" |
| 2529 | + # docstring inherited |
2560 | 2530 | with self.callbacks.blocked(): |
2561 | 2531 | # Pause callbacks while we are updating so we only get |
2562 | 2532 | # a single update signal at the end |
@@ -2565,7 +2535,7 @@ def autoscale(self, A): |
2565 | 2535 | self._changed() |
2566 | 2536 |
|
2567 | 2537 | def autoscale_None(self, A): |
2568 | | - """If *vmin* or *vmax* are not set, use the min/max of *A* to set them.""" |
| 2538 | + # docstring inherited |
2569 | 2539 | A = np.asanyarray(A) |
2570 | 2540 |
|
2571 | 2541 | if isinstance(A, np.ma.MaskedArray): |
@@ -2579,7 +2549,7 @@ def autoscale_None(self, A): |
2579 | 2549 | self.vmax = A.max() |
2580 | 2550 |
|
2581 | 2551 | def scaled(self): |
2582 | | - """Return whether *vmin* and *vmax* are both set.""" |
| 2552 | + # docstring inherited |
2583 | 2553 | return self.vmin is not None and self.vmax is not None |
2584 | 2554 |
|
2585 | 2555 |
|
|