17.2.5.5. cis.subsetting package¶
17.2.5.5.1. cis.subsetting.subset module¶
-
class
cis.subsetting.subset.
Subset
(limits, output_file, data_reader=<cis.data_io.data_reader.DataReader object>, data_writer=<cis.data_io.data_writer.DataWriter object>)¶ Bases:
object
Class for subsetting Ungridded or Gridded data either temporally, or spatially or both.
-
subset
(variables, filenames, product=None)¶ Subset the given variables based on the initialised limits
Parameters: - variables (string or list) – One or more variables to read from the files
- filenames (string or list) – One or more filenames of the files to read
- product (str) – Name of data product to use (optional)
-
17.2.5.5.2. cis.subsetting.subset_constraint module¶
-
class
cis.subsetting.subset_constraint.
CoordLimits
¶ Bases:
cis.subsetting.subset_constraint.CoordLimits
Holds the start and end values for subsetting limits. :ivar coord: the coordinate the limit applies to :ivar start: subsetting limit start :ivar end: subsetting limit end :ivar constraint_function: function determining whether the constraint is satisfied
-
class
cis.subsetting.subset_constraint.
GriddedSubsetConstraint
¶ Bases:
cis.subsetting.subset_constraint.SubsetConstraint
Implementation of SubsetConstraint for subsetting gridded data.
-
constrain
(data)¶ Subsets the supplied data using a combination of iris.cube.Cube.extract and iris.cube.Cube.intersection, depending on whether intersection is supported (whether the coordinate has a defined modulus). :param data: data to be subsetted :return: subsetted data or None if all data excluded. @rtype: cis.data_io.gridded_data.GriddedData
-
-
class
cis.subsetting.subset_constraint.
SubsetConstraint
¶ Bases:
cis.subsetting.subset_framework.SubsetConstraintInterface
Abstract Constraint for subsetting.
Holds the limits for subsetting in each dimension.
-
set_limit
(coord, dim_min, dim_max)¶ Sets boundary values for a dimension to be used in subsetting. :param coord: coordinate to which limit applies :param dim_min: lower bound on dimension or None to indicate no lower bound :param dim_max: upper bound on dimension or None to indicate no upper bound
-
-
class
cis.subsetting.subset_constraint.
UngriddedSubsetConstraint
¶ Bases:
cis.subsetting.subset_constraint.SubsetConstraint
Implementation of SubsetConstraint for subsetting ungridded data.
-
constrain
(data)¶ Subsets the supplied data.
Parameters: data – data to be subsetted Returns: subsetted data
-
17.2.5.5.3. cis.subsetting.subset_framework module¶
17.2.5.5.4. cis.subsetting.subset_limits module¶
-
class
cis.subsetting.subset_limits.
SubsetLimits
¶ Bases:
cis.subsetting.subset_limits.SubsetLimits
Holds the start and end values for subsetting limits. is_date indicates whether the limits are date/times - None if unknown :ivar start: subsetting limit start :type start: str :ivar end: subsetting limit end :type end: str :ivar is_time: indicates whether the limits apply to a time dimension: None if not known :type is_type: bool