epygram.fields — Fields

Contains all fields classes.

• epygram.fields.D3Field — 3-D Field class
  • _D3CommonField
    • _D3CommonField.as_dicts()
    • _D3CommonField.as_lists()
    • _D3CommonField.as_points()
    • _D3CommonField.as_profiles()
    • _D3CommonField.as_vcoordinate()
    • _D3CommonField.as_vtkGrid()
    • _D3CommonField.comment
    • _D3CommonField.dctspectrum()
    • _D3CommonField.decumulate()
    • _D3CommonField.dump_to_nc()
    • _D3CommonField.extend()
    • _D3CommonField.extract_physicallevels()
    • _D3CommonField.extract_subarray()
    • _D3CommonField.extract_subdomain()
    • _D3CommonField.extract_subsample()
    • _D3CommonField.extract_zoom()
    • _D3CommonField.extractprofile()
    • _D3CommonField.extractsection()
    • _D3CommonField.fid
    • _D3CommonField.getvalue_ll()
    • _D3CommonField.global_shift_center()
    • _D3CommonField.histogram()
    • _D3CommonField.max()
    • _D3CommonField.mean()
    • _D3CommonField.min()
    • _D3CommonField.misc_metadata
    • _D3CommonField.nonzero()
    • _D3CommonField.plot3DColor()
    • _D3CommonField.plot3DContour()
    • _D3CommonField.plot3DOutline()
    • _D3CommonField.plot3DVolume()
    • _D3CommonField.quadmean()
    • _D3CommonField.remove_level()
    • _D3CommonField.resample()
    • _D3CommonField.resample_on_regularll()
    • _D3CommonField.scatter_with()
    • _D3CommonField.sgmean()
    • _D3CommonField.shave()
    • _D3CommonField.spectral
    • _D3CommonField.stats()
    • _D3CommonField.std()
    • _D3CommonField.structure
    • _D3CommonField.time_reduce()
    • _D3CommonField.time_smooth()
    • _D3CommonField.units
    • _D3CommonField.use_field_as_vcoord()
    • _D3CommonField.vtk_guess_param_from_field()
    • _D3CommonField.what()
  • D3Field
    • D3Field.center()
    • D3Field.comment
    • D3Field.compute_xy_spderivatives()
    • D3Field.data
    • D3Field.fid
    • D3Field.geometry
    • D3Field.getdata()
    • D3Field.getlevel()
    • D3Field.getvalidity()
    • D3Field.getvalue_ij()
    • D3Field.gp2sp()
    • D3Field.misc_metadata
    • D3Field.processtype
    • D3Field.select_subzone()
    • D3Field.setdata()
    • D3Field.sp2gp()
    • D3Field.spectral_geometry
    • D3Field.structure
    • D3Field.units
    • D3Field.validity
  • D3VirtualField
    • D3VirtualField.comment
    • D3VirtualField.data
    • D3VirtualField.deldata()
    • D3VirtualField.fid
    • D3VirtualField.fieldset
    • D3VirtualField.getdata()
    • D3VirtualField.getlevel()
    • D3VirtualField.getvalue_ij()
    • D3VirtualField.gp2sp()
    • D3VirtualField.misc_metadata
    • D3VirtualField.resource
    • D3VirtualField.resource_fids
    • D3VirtualField.setdata()
    • D3VirtualField.sp2gp()
    • D3VirtualField.structure
    • D3VirtualField.units
• epygram.fields.H2DField — Horizontal 2-D Field class
  • H2DField
    • H2DField.cartoplot()
    • H2DField.cartoplot_background()
    • H2DField.cartoplot_fig_init()
    • H2DField.comment
    • H2DField.extract_contour()
    • H2DField.extract_point()
    • H2DField.fid
    • H2DField.geometry
    • H2DField.getlevel()
    • H2DField.indices_of_minmax_value()
    • H2DField.lonlat_of_minmax_value()
    • H2DField.misc_metadata
    • H2DField.morph_with_points()
    • H2DField.processtype
    • H2DField.spectral_geometry
    • H2DField.spectrum()
    • H2DField.structure
    • H2DField.units
    • H2DField.validity
• epygram.fields.H1DField — Horizontal 1-D Field class
  • H1DField
    • H1DField.comment
    • H1DField.fid
    • H1DField.geometry
    • H1DField.getlevel()
    • H1DField.misc_metadata
    • H1DField.plotanimation()
    • H1DField.plotfield()
    • H1DField.plothorizontalhovmoller()
    • H1DField.plottransects()
    • H1DField.processtype
    • H1DField.spectral_geometry
    • H1DField.structure
    • H1DField.units
    • H1DField.validity
  • plothorizontalhovmoller()
  • plottransects()
  • plotanimation()
• epygram.fields.V2DField — Vertical 2-D Field class
  • V2DField
    • V2DField.comment
    • V2DField.fid
    • V2DField.geometry
    • V2DField.misc_metadata
    • V2DField.processtype
    • V2DField.spectral_geometry
    • V2DField.structure
    • V2DField.units
    • V2DField.validity
• epygram.fields.V1DField — Vertical 1-D Field
  • V1DCommonField
    • V1DCommonField.comment
    • V1DCommonField.fid
    • V1DCommonField.misc_metadata
    • V1DCommonField.plotanimation()
    • V1DCommonField.plotfield()
    • V1DCommonField.plotprofiles()
    • V1DCommonField.plotverticalhovmoller()
    • V1DCommonField.structure
    • V1DCommonField.units
  • V1DField
    • V1DField.comment
    • V1DField.fid
    • V1DField.geometry
    • V1DField.misc_metadata
    • V1DField.processtype
    • V1DField.spectral_geometry
    • V1DField.structure
    • V1DField.units
    • V1DField.validity
  • V1DVirtualField
    • V1DVirtualField.comment
    • V1DVirtualField.fid
    • V1DVirtualField.fieldset
    • V1DVirtualField.misc_metadata
    • V1DVirtualField.resource
    • V1DVirtualField.resource_fids
    • V1DVirtualField.structure
    • V1DVirtualField.units
  • Functions
    • plotprofiles()
    • plotverticalhovmoller()
    • plotanimation()
• epygram.fields.PointField — Point 0-D Field class
  • gimme_one_point()
  • PointField
    • PointField.comment
    • PointField.fid
    • PointField.geometry
    • PointField.misc_metadata
    • PointField.plotfield()
    • PointField.processtype
    • PointField.spectral_geometry
    • PointField.structure
    • PointField.units
    • PointField.validity
• epygram.fields.MiscField — Miscellaneous Field class
  • MiscField
    • MiscField.comment
    • MiscField.datatype
    • MiscField.fid
    • MiscField.misc_metadata
    • MiscField.shape
    • MiscField.units
• epygram.fields.H2DVectorField — Horizontal 2-D Vector Field class
  • H2DVectorField
    • H2DVectorField.cartoimage()
    • H2DVectorField.cartoplot()
    • H2DVectorField.comment
    • H2DVectorField.components
    • H2DVectorField.fid
    • H2DVectorField.misc_metadata
    • H2DVectorField.processtype
    • H2DVectorField.structure
    • H2DVectorField.units
    • H2DVectorField.validity
    • H2DVectorField.vector
• epygram.fields.D3VectorField — 3-D Vector Field class
  • make_vector_field()
  • D3VectorField
    • D3VectorField.as_vtkGrid()
    • D3VectorField.attach_components()
    • D3VectorField.center()
    • D3VectorField.comment
    • D3VectorField.components
    • D3VectorField.compute_direction()
    • D3VectorField.compute_vordiv()
    • D3VectorField.data
    • D3VectorField.deldata()
    • D3VectorField.extract_subarray()
    • D3VectorField.extract_subdomain()
    • D3VectorField.extract_subsample()
    • D3VectorField.extract_zoom()
    • D3VectorField.fid
    • D3VectorField.getdata()
    • D3VectorField.getlevel()
    • D3VectorField.getvalue_ij()
    • D3VectorField.getvalue_ll()
    • D3VectorField.global_shift_center()
    • D3VectorField.gp2sp()
    • D3VectorField.map_factorize()
    • D3VectorField.max()
    • D3VectorField.mean()
    • D3VectorField.min()
    • D3VectorField.misc_metadata
    • D3VectorField.nonzero()
    • D3VectorField.plot3DOutline()
    • D3VectorField.plot3DStream()
    • D3VectorField.plot3DVector()
    • D3VectorField.processtype
    • D3VectorField.quadmean()
    • D3VectorField.remove_level()
    • D3VectorField.reproject_wind_on_lonlat()
    • D3VectorField.resample()
    • D3VectorField.resample_on_regularll()
    • D3VectorField.select_subzone()
    • D3VectorField.setdata()
    • D3VectorField.sp2gp()
    • D3VectorField.spectral
    • D3VectorField.std()
    • D3VectorField.structure
    • D3VectorField.to_module()
    • D3VectorField.units
    • D3VectorField.use_field_as_vcoord()
    • D3VectorField.validity
    • D3VectorField.vector
    • D3VectorField.vtk_guess_param_from_field()
    • D3VectorField.what()

---

epygram.fields.gimme_one_point(longitude, latitude, field_args=None, geometry_args=None, vertical_geometry_args=None, geometry_class=<class 'epygram.geometries.UnstructuredGeometry.UnstructuredGeometry'>)

Builds an empty PointField at given (longitude, latitude).

Parameters:

• field_args – to be passed to field constructor, e.g. a validity

• geometry_args – to be passed to geometry constructor

• vertical_geometry_args – to be passed to vertical_geometry constructor

• geometry_class – geometry class tu use (default: UnstructuredGeometry)

---

epygram.fields.make_vector_field(*components)

Creates a new epygram.D3VectorField or subclass from several epygram.D3Field or subclass representing the components of the vector in the field geometry.

---

epygram.fields.psikhi2uv(psi, khi)

Compute wind (on the grid) as a D3VectorField (or subclass) from streamfunction psi and velocity potential khi.