NEDAS.datasets package

Subpackages

• NEDAS.datasets.amsr2 package
  • Submodules
  • NEDAS.datasets.amsr2.amsr2_obs module
  • NEDAS.datasets.amsr2.rtm_amsr_fcts module
  • Module contents
• NEDAS.datasets.cs2smos package
  • Submodules
  • NEDAS.datasets.cs2smos.cs2smos_obs module
    • Cs2SmosObs
      • Cs2SmosObs.proj
      • Cs2SmosObs.xstart
      • Cs2SmosObs.xend
      • Cs2SmosObs.ystart
      • Cs2SmosObs.yend
      • Cs2SmosObs.dx
      • Cs2SmosObs.dy
      • Cs2SmosObs.obs_file_dt
      • Cs2SmosObs.obs_days
      • Cs2SmosObs.use_dataset_uncertainty
      • Cs2SmosObs.filename()
      • Cs2SmosObs.generate_obs_network()
      • Cs2SmosObs.read_obs_from_file()
  • Module contents
    • Cs2SmosObs
      • Cs2SmosObs.proj
      • Cs2SmosObs.xstart
      • Cs2SmosObs.xend
      • Cs2SmosObs.ystart
      • Cs2SmosObs.yend
      • Cs2SmosObs.dx
      • Cs2SmosObs.dy
      • Cs2SmosObs.obs_file_dt
      • Cs2SmosObs.obs_days
      • Cs2SmosObs.use_dataset_uncertainty
      • Cs2SmosObs.filename()
      • Cs2SmosObs.generate_obs_network()
      • Cs2SmosObs.read_obs_from_file()
• NEDAS.datasets.rgps package
  • Submodules
  • NEDAS.datasets.rgps.rgps_obs module
    • RgpsObs
      • RgpsObs.dataset_dir
      • RgpsObs.proj4
      • RgpsObs.DAYS_SEARCH_TOLERANCE
      • RgpsObs.DRIFT_MAX
      • RgpsObs.DRIFT_ERR_STD
      • RgpsObs.DEFORM_MAX
      • RgpsObs.DEFORM_ERR_STD
      • RgpsObs.parse_kwargs()
      • RgpsObs.filename()
      • RgpsObs.read_obs_from_file()
      • RgpsObs.get_model_files()
      • RgpsObs.get_traj_pairs()
      • RgpsObs.get_seaice_drift()
      • RgpsObs.get_seaice_deform_shear()
      • RgpsObs.get_seaice_deform_div()
      • RgpsObs.get_seaice_deform_vort()
  • NEDAS.datasets.rgps.utils module
    • get_data_traj_pairs()
    • get_triangulation()
    • get_velocity()
    • get_velocity_gradients()
    • get_deform_shear()
    • get_deform_div()
    • get_deform_vort()
  • Module contents
    • RgpsObs
      • RgpsObs.dataset_dir
      • RgpsObs.proj4
      • RgpsObs.DAYS_SEARCH_TOLERANCE
      • RgpsObs.DRIFT_MAX
      • RgpsObs.DRIFT_ERR_STD
      • RgpsObs.DEFORM_MAX
      • RgpsObs.DEFORM_ERR_STD
      • RgpsObs.parse_kwargs()
      • RgpsObs.filename()
      • RgpsObs.read_obs_from_file()
      • RgpsObs.get_model_files()
      • RgpsObs.get_traj_pairs()
      • RgpsObs.get_seaice_drift()
      • RgpsObs.get_seaice_deform_shear()
      • RgpsObs.get_seaice_deform_div()
      • RgpsObs.get_seaice_deform_vort()
• NEDAS.datasets.synthetic package
  • Submodules
  • NEDAS.datasets.synthetic.synthetic_obs module
    • SyntheticObs
      • SyntheticObs.nobs
      • SyntheticObs.obs_position
      • SyntheticObs.obs_x
      • SyntheticObs.obs_y
      • SyntheticObs.obs_z
      • SyntheticObs.generate_obs_network()
      • SyntheticObs.read_obs_from_file()
  • Module contents
    • SyntheticObs
      • SyntheticObs.nobs
      • SyntheticObs.obs_position
      • SyntheticObs.obs_x
      • SyntheticObs.obs_y
      • SyntheticObs.obs_z
      • SyntheticObs.generate_obs_network()
      • SyntheticObs.read_obs_from_file()
• NEDAS.datasets.topaz package
  • Submodules
  • NEDAS.datasets.topaz.topaz_prep_obs module
    • TopazPrepObs
      • TopazPrepObs.filename()
      • TopazPrepObs.generate_obs_network()
      • TopazPrepObs.read_obs_from_file()
      • TopazPrepObs.get_seaice_drift()
  • NEDAS.datasets.topaz.uf_data module
    • read_uf_data()
  • Module contents
    • TopazPrepObs
      • TopazPrepObs.filename()
      • TopazPrepObs.generate_obs_network()
      • TopazPrepObs.read_obs_from_file()
      • TopazPrepObs.get_seaice_drift()
• NEDAS.datasets.vort2d package
  • Submodules
  • NEDAS.datasets.vort2d.vort2d_obs module
    • Vort2DObs
      • Vort2DObs.generate_obs_network()
      • Vort2DObs.vortex_position()
      • Vort2DObs.vortex_intensity()
      • Vort2DObs.vortex_size()
      • Vort2DObs.get_velocity()
      • Vort2DObs.get_vortex_position()
      • Vort2DObs.get_vortex_intensity()
      • Vort2DObs.get_vortex_size()
  • Module contents
    • Vort2DObs
      • Vort2DObs.generate_obs_network()
      • Vort2DObs.vortex_position()
      • Vort2DObs.vortex_intensity()
      • Vort2DObs.vortex_size()
      • Vort2DObs.get_velocity()
      • Vort2DObs.get_vortex_position()
      • Vort2DObs.get_vortex_intensity()
      • Vort2DObs.get_vortex_size()

Module contents

NEDAS.datasets.get_dataset_class(dataset_name: str) → Type['Dataset']

Factory function to return the correct Dataset subclass.

Parameters:

dataset_name (str) – Dataset name

Returns:

Corresponding Dataset subclass.

Return type:

Type[“Dataset”]