Skip to content

Clean up updates for basic_elements docs pages #570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaronayres35 merged 2 commits into from
Mar 10, 2021
Merged

Clean up updates for basic_elements docs pages #570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60fccae
Clean up updates for docs/source/user_manual/basic_elements/
aaronayres35 Mar 9, 2021
c4d4607
Update docs/source/user_manual/basic_elements/overlays.rst
aaronayres35 Mar 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 47 additions & 55 deletions docs/source/user_manual/basic_elements/data_ranges.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _data_ranges:

===========
Data ranges
===========
Expand All @@ -23,70 +25,62 @@ and
This is a summary of the most important attributes and methods
(see the docstrings of this class for more details):

**Attributes**

:attr:`~chaco.abstract_data_range.AbstractDataRange.sources`

A list of data sources associated to the data range. Concrete implementations
of data range listen to the event
:attr:`~chaco.abstract_data_source.AbstractDataSource.data_changed`
and refresh their bounds as appropriate (e.g., when the bounds are
set to ``auto``).

:attr:`~chaco.abstract_data_range.AbstractDataRange.low`

The actual value of the lower bounds of the range. The correct way
to set it is to use the :attr:`low_setting` attribute.

:attr:`~chaco.abstract_data_range.AbstractDataRange.high`

The actual value of the upper bounds of the range. The correct way
to set it is to use the :attr:`high_setting` attribute.
Attributes
^^^^^^^^^^

:attr:`~chaco.abstract_data_range.AbstractDataRange.low_setting`
:attr:`~chaco.abstract_data_range.AbstractDataRange.sources`
A list of data sources associated to the data range. Concrete implementations
of data range listen to the event
:attr:`~chaco.abstract_data_source.AbstractDataSource.data_changed`
and refresh their bounds as appropriate (e.g., when the bounds are
set to ``auto``).

Setting for the lower bound of the range. This can either be a valid
lower bound value, or ``auto`` (default), in which case the
lower bound is set automatically from the associated data sources.
:attr:`~chaco.abstract_data_range.AbstractDataRange.low`
The actual value of the lower bounds of the range. The correct way
to set it is to use the :attr:`low_setting` attribute.

:attr:`~chaco.abstract_data_range.AbstractDataRange.high_setting`
:attr:`~chaco.abstract_data_range.AbstractDataRange.high`
The actual value of the upper bounds of the range. The correct way
to set it is to use the :attr:`high_setting` attribute.

Setting for the upper bound of the range. This can either be a valid
upper bound value, or ``auto`` (default), in which case the
upper bound is set automatically from the associated data sources.
:attr:`~chaco.abstract_data_range.AbstractDataRange.low_setting`
Setting for the lower bound of the range. This can either be a valid
lower bound value, or ``auto`` (default), in which case the
lower bound is set automatically from the associated data sources.

:attr:`~chaco.abstract_data_range.AbstractDataRange.high_setting`
Setting for the upper bound of the range. This can either be a valid
upper bound value, or ``auto`` (default), in which case the
upper bound is set automatically from the associated data sources.

**Methods**

:attr:`~chaco.base_data_range.BaseDataRange.add(*datasources)`
Methods
^^^^^^^

Convenience method to associate one or more data sources to the range.
The method avoids adding the same data source twice.
:meth:`~chaco.base_data_range.BaseDataRange.add`
Convenience method to associate one or more data sources to the range.
The method avoids adding the same data source twice.

:attr:`~chaco.base_data_range.BaseDataRange.remove(*datasources)`
:meth:`~chaco.base_data_range.BaseDataRange.remove`
Convenience method to remove one or more data sources from the range.
If one of the data sources is not associated with the range,
it is ignored.

Convenience method to remove one or more data sources from the range.
If one of the data sources is not associated with the range,
it is ignored.
:meth:`~chaco.abstract_data_range.AbstractDataRange.clip_data`
Given an array of data values of the same dimensionality as the range,
return a list of data values that are inside the range.

:attr:`~chaco.abstract_data_range.AbstractDataRange.clip_data(data)`
:meth:`~chaco.abstract_data_range.AbstractDataRange.mask_data`
Given an array of data values of the same dimensionality as the range,
this method returns a mask array of the same length as data, filled
with 1s and 0s corresponding to whether the data value at that index
is inside or outside the range.

Given an array of data values of the same dimensionality as the range,
return a list of data values that are inside the range.

:attr:`~chaco.abstract_data_range.AbstractDataRange.mask_data(data)`

Given an array of data values of the same dimensionality as the range,
this method returns a mask array of the same length as data, filled
with 1s and 0s corresponding to whether the data value at that index
is inside or outside the range.

:attr:`~chaco.abstract_data_range.AbstractDataRange.bound_data(data)`

Given an array of *monotonic* data values of the same dimensionality
as the range,
returns a tuple of indices (start, end) corresponding to the first and
last elements that fall within the range.
:meth:`~chaco.abstract_data_range.AbstractDataRange.bound_data`
Given an array of *monotonic* data values of the same dimensionality
as the range,
returns a tuple of indices (start, end) corresponding to the first and
last elements that fall within the range.


Events
Expand All @@ -104,7 +98,6 @@ There are two data range implementations in Chaco, one for 1D and one
for 2D ranges:

:class:`~chaco.data_range_1d.DataRange1D`

:class:`~chaco.data_range_1d.DataRange1D` represents a 1D data range. This
subclass adds several more ways to control the bound of the range given
the associated data sources.
Expand Down Expand Up @@ -136,9 +129,8 @@ for 2D ranges:


:class:`~chaco.data_range_2d.DataRange2D`

:class:`~chaco.data_range_2d.DataRange2D` represents a 2D data range.
Under the hood, it is implemented using two
Internally, it is implemented using two
:class:`~chaco.data_range_1d.DataRange1D` objects,
one for each dimension,
which are stored in the
Expand Down
Loading