eva.plotting.emcpy.diagnostics package#

Submodules#

eva.plotting.emcpy.diagnostics.density module#

class eva.plotting.emcpy.diagnostics.density.Density(config, logger, dataobj)[source]#

Bases: object

Base class for creating density plots.

Creates a density plot based on the provided configuration and data.

Parameters:

  • config (dict) – A dictionary containing the configuration for the density plot.

  • logger (Logger) – An instance of the logger for logging messages.

  • dataobj – An instance of the data object containing input data.

This class initializes and configures a density plot based on the provided configuration and data. The density plot is created using a declarative plotting library from EMCPy (NOAA-EMC/emcpy).

Example

config = {
    "data": {
        "variable": "collection::group::variable",
        "channel": "channel_name",
        "slicing": "slice expression"
    },
    "plot_property": "property_value",
    "plot_option": "option_value",
    "schema": "path_to_schema_file.yaml"
}
logger = Logger()
dataobj = DataObject()
density_plot = Density(config, logger, dataobj)

eva.plotting.emcpy.diagnostics.histogram module#

class eva.plotting.emcpy.diagnostics.histogram.Histogram(config, logger, dataobj)[source]#

Bases: object

Base class for creating histogram plots.

Creates a histogram plot based on the provided configuration and data.

Parameters:

  • config (dict) – A dictionary containing the configuration for the histogram plot.

  • logger (Logger) – An instance of the logger for logging messages.

  • dataobj – An instance of the data object containing input data.

This class initializes and configures a histogram plot based on the provided configuration and data. The histogram plot is created using a declarative plotting library from EMCPy (NOAA-EMC/emcpy).

Example

config = {
    "data": {
        "variable": "collection::group::variable",
        "channel": "channel_name",
        "slicing": "slice expression"
    },
    "plot_property": "property_value",
    "plot_option": "option_value",
    "schema": "path_to_schema_file.yaml"
}
logger = Logger()
dataobj = DataObject()
histogram_plot = Histogram(config, logger, dataobj)

eva.plotting.emcpy.diagnostics.horizontal_line module#

class eva.plotting.emcpy.diagnostics.horizontal_line.HorizontalLine(config, logger, dataobj)[source]#

Bases: object

Base class for creating horizontal line plots.

Creates a horizontal line plot based on the provided configuration.

Parameters:

  • config (dict) – A dictionary containing the configuration for the horizontal line plot.

  • logger (Logger) – An instance of the logger for logging messages.

This class initializes and configures a horizontal line plot based on the provided configuration. The horizontal line plot is created using a declarative plotting library from EMCPy (NOAA-EMC/emcpy).

Example

config = {
    "y": 0.5,
    "plot_property": "property_value",
    "plot_option": "option_value",
    "schema": "path_to_schema_file.yaml"
}
logger = Logger()
horizontal_line_plot = HorizontalLine(config, logger)

eva.plotting.emcpy.diagnostics.line_plot module#

class eva.plotting.emcpy.diagnostics.line_plot.LinePlot(config, logger, dataobj)[source]#

Bases: object

Base class for creating line plots.

Creates a line plot based on the provided configuration.

Parameters:

  • config (dict) – A dictionary containing the configuration for the line plot.

  • logger (Logger) – An instance of the logger for logging messages.

  • dataobj – An instance of the data object containing input data.

This class initializes and configures a line plot based on the provided configuration. The line plot is created using a declarative plotting library from EMCPy (NOAA-EMC/emcpy).

Example

config = {
    "x": {"variable": "collection::group::variable"},
    "y": {"variable": "collection::group::variable"},
    "channel": "channel_name",
    "plot_property": "property_value",
    "plot_option": "option_value",
    "schema": "path_to_schema_file.yaml"
}
logger = Logger()
line_plot = LinePlot(config, logger, None)

eva.plotting.emcpy.diagnostics.map_gridded module#

class eva.plotting.emcpy.diagnostics.map_gridded.MapGridded(config, logger, dataobj)[source]#

Bases: object

Base class for creating map gridded plots.

Creates a gridded map plot based on the provided configuration.

Parameters:

  • config (dict) – A dictionary containing the configuration for the gridded map plot.

  • logger (Logger) – An instance of the logger for logging messages.

  • dataobj – An instance of the data object containing input data.

This class initializes and configures a gridded map plot based on the provided configuration. The gridded map plot is created using a declarative plotting library from EMCPy (NOAA-EMC/emcpy).

Example

config = {
    "longitude": {"variable": "collection::group::variable"},
    "latitude": {"variable": "collection::group::variable"},
    "data": {"variable": "collection::group::variable"},
    "plot_property": "property_value",
    "plot_option": "option_value",
    "schema": "path_to_schema_file.yaml"
}
logger = Logger()
map_plot = MapGridded(config, logger, None)

eva.plotting.emcpy.diagnostics.map_scatter module#

class eva.plotting.emcpy.diagnostics.map_scatter.MapScatter(config, logger, dataobj)[source]#

Bases: object

Base class for creating map scatter plots.

Creates a scatter plot on a map based on the provided configuration.

Parameters:

  • config (dict) – A dictionary containing the configuration for the scatter plot on a map.

  • logger (Logger) – An instance of the logger for logging messages.

  • dataobj – An instance of the data object containing input data.

This class initializes and configures a scatter plot on a map based on the provided configuration. The scatter plot is created using a declarative plotting library from EMCPy (NOAA-EMC/emcpy).

Example

config = {
    "longitude": {"variable": "collection::group::variable"},
    "latitude": {"variable": "collection::group::variable"},
    "data": {"variable": "collection::group::variable",
             "channel": "channel_name"},
    "plot_property": "property_value",
    "plot_option": "option_value",
    "schema": "path_to_schema_file.yaml"
}
logger = Logger()
map_scatter_plot = MapScatter(config, logger, None)

eva.plotting.emcpy.diagnostics.scatter module#

class eva.plotting.emcpy.diagnostics.scatter.Scatter(config, logger, dataobj)[source]#

Bases: object

Base class for creating scatter plots.

Creates a scatter plot on a map based on the provided configuration.

Parameters:

  • config (dict) – A dictionary containing the configuration for the scatter plot on a map.

  • logger (Logger) – An instance of the logger for logging messages.

  • dataobj – An instance of the data object containing input data.

This class initializes and configures a scatter plot on a map based on the provided configuration. The scatter plot is created using a declarative plotting library from EMCPy (NOAA-EMC/emcpy).

Example

config = {
    "longitude": {"variable": "collection::group::variable"},
    "latitude": {"variable": "collection::group::variable"},
    "data": {"variable": "collection::group::variable",
             "channel": "channel_name"},
    "plot_property": "property_value",
    "plot_option": "option_value",
    "schema": "path_to_schema_file.yaml"
}
logger = Logger()
map_scatter_plot = MapScatter(config, logger, None)

eva.plotting.emcpy.diagnostics.vertical_line module#

class eva.plotting.emcpy.diagnostics.vertical_line.VerticalLine(config, logger, dataobj)[source]#

Bases: object

Base class for creating vertical line plots.

Creates a vertical line plot based on the provided configuration.

Parameters:

  • config (dict) – A dictionary containing the configuration for the vertical line plot.

  • logger (Logger) – An instance of the logger for logging messages.

  • dataobj – Not used in this context.

This class initializes and configures a vertical line plot based on the provided configuration. The vertical line plot is created using a declarative plotting library from EMCPy (NOAA-EMC/emcpy).

Example

config = {
    "x": 10,
    "plot_property": "property_value",
    "plot_option": "option_value",
    "schema": "path_to_schema_file.yaml"
}
logger = Logger()
vertical_line_plot = VerticalLine(config, logger, None)

Module contents#