Values

class astropy.io.votable.tree.Values(votable, field, ID=None, null=None, ref=None, type='legal', id=None, config={}, pos=None, **extras) [edit on github][source]

Bases: astropy.io.votable.tree.Element, astropy.io.votable.tree._IDProperty

VALUES element: used within FIELD and PARAM elements to define the domain of values.

The keyword arguments correspond to setting members of the same name, documented below.

Attributes Summary

max The maximum value of the domain.
min_inclusive When True, the domain includes the minimum value.
null For integral datatypes, null is used to define the value used for missing values.
max_inclusive When True, the domain includes the maximum value.
min The minimum value of the domain.
ref Refer to another VALUES element by ID, defined previously in the document, for MIN/MAX/OPTION information.
type [required] Defines the applicability of the domain defined
options A list of string key-value tuples defining other OPTION elements for the domain.

Methods Summary

parse(iterator, config)
to_xml(w, **kwargs)
to_table_column(column)
from_table_column(column)
is_defaults()

Attributes Documentation

max[source]

The maximum value of the domain. See max_inclusive.

min_inclusive[source]

When True, the domain includes the minimum value.

null[source]

For integral datatypes, null is used to define the value used for missing values.

max_inclusive[source]

When True, the domain includes the maximum value.

min[source]

The minimum value of the domain. See min_inclusive.

ref[source]

Refer to another VALUES element by ID, defined previously in the document, for MIN/MAX/OPTION information.

type[source]

[required] Defines the applicability of the domain defined by this VALUES element. Must be one of the following strings:

  • ‘legal’: The domain of this column applies in general to this datatype. (default)
  • ‘actual’: The domain of this column applies only to the data enclosed in the parent table.
options[source]

A list of string key-value tuples defining other OPTION elements for the domain. All options are ignored – they are stored for round-tripping purposes only.

Methods Documentation

parse(iterator, config) [edit on github][source]
to_xml(w, **kwargs) [edit on github][source]
to_table_column(column) [edit on github][source]
from_table_column(column) [edit on github][source]
is_defaults() [edit on github][source]

Page Contents