1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
|
.. currentmodule:: cf
.. default-role:: obj
.. _function:
Functions of the :mod:`cf` module
=================================
Input and output
----------------
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.close_files
cf.close_one_file
cf.dump
cf.open_files
cf.open_files_threshold_exceeded
cf.pickle
cf.read
cf.write
cf.unpickle
Aggregation
-----------
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.aggregate
.. _functions-mathematical-operations:
Mathematical operations
-----------------------
Comparison
----------
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.equals
cf.equivalent
The following functions generate `cf.Query` instances for evaluating
objects against given criteria. For example, ``cf.wi(3, 5)`` generates
a query for testing whether, or where, an object is in the range [3,
5].
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.contain
cf.eq
cf.ge
cf.gt
cf.le
cf.lt
cf.ne
cf.set
cf.wi
cf.wo
**Climatological seasons**
The following functions generate `cf.Query` instances for evaluating
objects against given criteria. For example, ``cf.djf()`` generates a
query for testing whether, or where, a date-time object is in a
December--February season.
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.djf
cf.mam
cf.jja
cf.son
cf.seasons
**Date-time**
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.dteq
cf.dtge
cf.dtgt
cf.dtle
cf.dtlt
cf.dtne
cf.year
cf.month
cf.day
cf.hour
cf.minute
cf.second
**Coordinate cell bounds**
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.cellgt
cf.cellge
cf.cellle
cf.celllt
cf.cellwi
cf.cellwo
cf.cellsize
Date-time
---------
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.dt
cf.Y
cf.M
cf.D
cf.h
cf.m
cf.s
Retrieval and setting of constants
----------------------------------
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.ATOL
cf.CHUNKSIZE
cf.FM_THRESHOLD
cf.MINNCFM
cf.OF_FRACTION
cf.REGRID_LOGGING
cf.RTOL
cf.TEMPDIR
Miscellaneous
-------------
.. autosummary::
:nosignatures:
:toctree: generated/
:template: function.rst
cf.abspath
cf.dirname
cf.flat
cf.pathjoin
cf.relpath
|