Skip to content

Remove codes for unsupported features: mask and scale #49

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.

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
merged 1 commit into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 4 additions & 23 deletions docs/source/api/variable_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ function-call style methods or indexer-style (numpy-like) syntax.

.. autoclass:: pnetcdf::Variable
:members: ncattrs, put_att, get_att, del_att, rename_att, get_dims, def_fill,
inq_fill, fill_rec, set_auto_chartostring, set_auto_scale, set_auto_mask,
set_auto_maskandscale, put_var, put_var_all, get_var, get_var_all, iput_var, bput_var
iget_var, inq_offset
inq_fill, fill_rec, set_auto_chartostring, put_var, put_var_all, get_var,
get_var_all, iput_var, bput_var iget_var, inq_offset
:exclude-members: name, shape, size


Expand All @@ -31,7 +30,7 @@ Variable Attributes
.. attribute:: dtype


Return the mapped numpy data type of the variable netCDF datatype. A numpy dtype object
Return the mapped numpy data type of the variable netCDF datatype. A numpy dtype object
describing the variable's data type.
**Type:** ``numpy.dtype``

Expand All @@ -44,7 +43,7 @@ Variable Attributes
.. attribute:: shape


Return the shape of the variable, which is the current sizes of all variable
Return the shape of the variable, which is the current sizes of all variable
dimensions
**Type:** `Tuple[int, int]`

Expand All @@ -66,26 +65,8 @@ Variable Attributes
Return the variable's dimension names
**Type:** `List[str]`

.. attribute:: scale

Only relevant when using indexer syntax to read from or write to netCDF variable.
If True, `scale_factor` and `add_offset` are applied, and signed integer data is
automatically converted to unsigned integer data if the `_Unsigned` attribute is set.
Default is `True`, can be reset using :meth:`Variable.set_auto_scale` and
:meth:`Variable.set_auto_maskandscale` methods.
**Type:** `bool`

.. attribute:: mask

Only relevant when using indexer syntax to read from netCDF variable. If `True`,
data is automatically converted to/from masked arrays when missing values or fill
values are present. Default is `True`, can be reset using :meth:`Variable.set_auto_mask`
and :meth:`Variable.set_auto_maskandscale` methods.
**Type:** `bool`

.. attribute:: chartostring


If `True`, data is automatically converted to/from character
arrays to string arrays when the `_Encoding` variable attribute is set.
Default is `True`, can be reset using :meth:`Variable.set_auto_chartostring` method.
Expand Down
2 changes: 1 addition & 1 deletion src/pnetcdf/_Variable.pxd
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ from._Dimension cimport Dimension
cdef class Variable:
cdef public int _varid, _file_id, _nunlimdim
cdef public File _file
cdef public _name, ndim, dtype, xtype, mask, scale, always_mask, chartostring
cdef public _name, ndim, dtype, xtype, chartostring
Loading
Loading