cf.FieldList

class cf.FieldList(sequence=())[source]

Bases: cf.variablelist.VariableList

An ordered sequence of fields stored in a list-like object.

In some contexts, whether an object is a field or a field list is not known and does not matter. So to avoid ungainly type testing, some aspects of the FieldList interface are shared by a field and vice versa.

Any attribute or method belonging to a field may be used on a field list and will be applied independently to each element.

Just as it is straight forward to iterate over the fields in a field list, a field will behave like a single element field list in iterative and indexing contexts.

Initialization

Parameters :
sequence : iterable, optional

Define a new list with these elements.

FieldList attributes

subspace Slice each field in the list, returning a new list of fields.

FieldList methods

append
coord Apply the coord method to each field of the list.
copy Return a deep copy.
count Return the number of occurrences of a given value.
delprop Delete a CF property from each element of the list.
dump Return a string containing the full descriptions of each variable in
equals True if two instances are equal, False otherwise.
extend
getprop Return a built-in list of a CF properties from each element.
hasprop Return a built-in list describing whether each element has a CF
index Return the first index of a given value.
insert Insert an object before the given index in place.
match Return a list of booleans showing which elements match the given conditions.
name Return a built-in list of the names of each element of the list of
override_units Override the each element’s data array units in place.
pop
remove
reverse
select Return the elements which match the given conditions.
set_equals True if two instances are set-wise equal, False otherwise.
setprop Set a CF property on each element of the list.
sort Sort the elements in place.
squeeze Apply the squeeze method to each field of the list.
unsqueeze Apply the unsqueeze method to each field of the list.

Table Of Contents

Previous topic

cf.CoordinateList.sort

Next topic

cf.FieldList.subspace

This Page