CFAxisLongitude | R Documentation |
This class represents a longitude axis. Its values are numeric. This class is used for axes that represent longitudes. This class adds some logic that is specific to longitudes, such as their range, orientation and their meaning. (In the near future, it will also support selecting data that crosses the 0-360 degree boundary.)
ncdfCF::CFObject
-> ncdfCF::CFAxis
-> ncdfCF::CFAxisNumeric
-> CFAxisLongitude
friendlyClassName
(read-only) A nice description of the class.
ncdfCF::CFObject$append_attribute()
ncdfCF::CFObject$attribute()
ncdfCF::CFObject$delete_attribute()
ncdfCF::CFObject$dim()
ncdfCF::CFObject$print_attributes()
ncdfCF::CFObject$set_attribute()
ncdfCF::CFObject$update_coordinates_attribute()
ncdfCF::CFObject$write_attributes()
ncdfCF::CFAxis$can_append()
ncdfCF::CFAxis$configure_terms()
ncdfCF::CFAxis$copy_terms()
ncdfCF::CFAxis$detach()
ncdfCF::CFAxis$peek()
ncdfCF::CFAxis$shard()
ncdfCF::CFAxis$write()
ncdfCF::CFAxisNumeric$brief()
ncdfCF::CFAxisNumeric$identical()
ncdfCF::CFAxisNumeric$indexOf()
ncdfCF::CFAxisNumeric$print()
ncdfCF::CFAxisNumeric$range()
ncdfCF::CFAxisNumeric$slice()
new()
Create a new instance of this class.
Creating a new longitude axis is more easily done with the
makeLongitudeAxis()
function.
CFAxisLongitude$new( var, values, start = 1L, count = NA, attributes = data.frame() )
var
The name of the axis when creating a new axis. When reading an axis from file, the NCVariable object that describes this instance.
values
Optional. The values of the axis in a vector. The values
have to be numeric with the maximum value no larger than the minimum
value + 360, and monotonic. Ignored when argument var
is a NCVariable
object.
start
Optional. Integer index where to start reading axis data
from file. The index may be NA
to start reading data from the start.
count
Optional. Number of elements to read from file. This may be
NA
to read to the end of the data.
attributes
Optional. A data.frame
with the attributes of the
axis. When an empty data.frame
(default) and argument var
is an
NCVariable instance, attributes of the axis will be taken from the
netCDF resource.
copy()
Create a copy of this axis. The copy is completely separate
from self
, meaning that both self
and all of its components are made
from new instances.
CFAxisLongitude$copy(name = "")
name
The name for the new axis. If an empty string is passed, will use the name of this axis.
The newly created axis.
copy_with_values()
Create a copy of this axis but using the supplied values. The attributes are copied to the new axis. Boundary values and auxiliary coordinates are not copied.
After this operation the attributes of the newly created axes may not be accurate, except for the "actual_range" attribute. The calling code should set, modify or delete attributes as appropriate.
CFAxisLongitude$copy_with_values(name = "", values)
name
The name for the new axis. If an empty string is passed, will use the name of this axis.
values
The values to the used with the copy of this axis.
The newly created axis.
subset()
Return a longitude axis spanning a smaller coordinate range.
This method returns an axis which spans the range of indices given by
the rng
argument.
CFAxisLongitude$subset(name = "", rng = NULL)
name
The name for the new axis. If an empty string is passed (default), will use the name of this axis.
rng
The range of indices whose values from this axis to include in
the returned axis. If the value of the argument is NULL
, return a
copy of the axis.
A new CFAxisLongitude
instance covering the indicated range of
indices. If the value of the argument rng
is NULL
, return a copy of
self
as the new axis.
append()
Append a vector of values at the end of the current values
of the axis. Boundary values are appended as well but if either this
axis or the from
axis does not have boundary values, neither will the
resulting axis.
CFAxisLongitude$append(from)
from
An instance of CFAxisLongitude
whose values to append to
the values of this axis.
A new CFAxisLongitude
instance with values from this axis and
the from
axis appended.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.