Processes API

Subset Processes API

Sub-setting is performed with ocgis. Appropriate functions are located in eggshell.



class flyingpigeon.processes.wps_pointinspection.PointinspectionProcess[source]

pointinspection Point Inspection (v0.10)

Extract the timeseries at the given coordinates.

Parameters
  • resource (application/x-netcdf, application/x-tar, application/zip) – NetCDF files or archive (tar/zip) containing NetCDF files.

  • coords (string) – Comma-seperated tuple of WGS85 lon, lat decimal coordinates (e.g. 2.356138, 48.846450).

Returns

tarout – Tar archive containing one CSV file per input file, each one storing time series column-wise for all point coordinates.

Return type

application/x-tar

References



class flyingpigeon.processes.wps_subset_wfs_polygon.SubsetWFSPolygonProcess[source]

subset-wfs-polygon Subset (v0.2)

Return the data for which grid cells intersect the selected polygon for each input dataset as well asthe time range selected.

Parameters
  • resource (application/x-netcdf, application/x-ogc-dods) – NetCDF file or OPEnDAP url pointing to netCDF file.

  • typename (string, optional) – Name of the layer in GeoServer.

  • featureids (string, optional) – fid(s) of the feature in the layer.

  • geoserver (string, optional) – Typically of the form http://host:port/geoserver/wfs

  • mosaic (boolean, optional) – If True, selected regions will be merged into a single geometry.

  • start (dateTime, optional) – Initial datetime for temporal subsetting.

  • end (dateTime, optional) – Final datetime for temporal subsetting.

  • variable (string, optional) – Name of the variable in the NetCDF file.Will be guessed if not provided.

Returns

  • output (application/x-netcdf) – NetCDF output for first resource file.

  • metalink (application/metalink+xml; version=4.0) – Metalink file with links to all NetCDF outputs.



class flyingpigeon.processes.wps_subset_continents.SubsetcontinentProcess[source]

subset_continents Subset Continents (v0.11)

Return the data whose grid cells intersect the selected continents for each input dataset.

Parameters
  • region ({'Africa', 'Asia', 'Australia', 'North America', 'Oceania', 'South America', 'Antarctica', 'Europe'}) – Continent name.

  • mosaic (boolean, optional) – If True, selected regions will be merged into a single geometry.

  • resource (application/x-netcdf, application/x-tar, application/zip) – NetCDF Files or archive (tar/zip) containing netCDF files.

Returns

  • output (application/x-tar) – Tar archive of the subsetted netCDF files.

  • ncout (application/x-netcdf) – NetCDF file with subset for one dataset.

References



class flyingpigeon.processes.wps_subset_countries.SubsetcountryProcess[source]

subset_countries Subset Countries (v0.11)

Return the data whose grid cells intersect the selected countries for each input dataset.

Parameters
  • region ({'ABW', 'AFG', 'AGO', 'ALB', 'ALD', 'AND', 'ARE', 'ARG', 'ARM', 'ASM', ..}) – Country code, see ISO-3166-3: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements

  • mosaic (boolean, optional) – If True, selected regions will be merged into a single geometry.

  • resource (application/x-netcdf, application/x-tar, application/zip) – NetCDF Files or archive (tar/zip) containing NetCDF files.

Returns

  • output (application/x-tar) – Tar archive of the subsetted netCDF files.

  • ncout (application/x-netcdf) – NetCDF file with subset for one dataset.

References



class flyingpigeon.processes.wps_subset_bbox.SubsetBboxProcess[source]

subset_bbox Subset netCDF file on bounding box (v0.2)

Return the data for which grid cells intersect the bounding box for each input dataset as well asthe time range selected. This implies that the centroid ofa grid cell can be outside the bounding box.

Parameters
  • resource (application/x-netcdf, application/x-ogc-dods) – NetCDF file or OPEnDAP url pointing to netCDF file.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • start (dateTime, optional) – Initial datetime for temporal subsetting.

  • end (dateTime, optional) – Final datetime for temporal subsetting.

  • variable (string, optional) – Name of the variable in the NetCDF file.Will be guessed if not provided.

Returns

  • output (application/x-netcdf) – NetCDF output for first resource file.

  • metalink (application/metalink+xml; version=4.0) – Metalink file with links to all NetCDF outputs.

References



Plot Timeseries API

class flyingpigeon.processes.wps_plot_timeseries.PlottimeseriesProcess[source]

plot_timeseries Graphics (timeseries) (v0.11)

Outputs some timeseries of the file field means. Spaghetti and uncertainty plot

Parameters
  • resource (application/x-netcdf, application/x-tar, application/zip) – NetCDF Files or archive (tar/zip) containing NetCDF files. (Info)

  • variable (string, optional) – Variable to be expected in the input files (variable will be detected if not set)

Returns

  • plotout_spagetti (image/png) – Visualisation of single variables as a spaghetti plot

  • plotout_uncertainty (image/png) – Visualisation of single variables ensemble mean with uncertainty

References



Spatial Analogs API

class flyingpigeon.processes.wps_spatial_analog.SpatialAnalogProcess[source]

spatial_analog Spatial analog of a target climate. (v0.2)

Spatial analogs based on the comparison of climate indices. The algorithm compares the distribution of the target indices with the distribution of spatially distributed candidate indices and returns a value measuring the dissimilarity between both distributions over the candidate grid.

Parameters
  • candidate (application/x-netcdf, application/x-tar, application/zip) –

    NetCDF files or archive (tar/zip) storing the candidate indices. The output will be stored on this grid. (Info)

  • target (application/x-netcdf, application/x-tar, application/zip) –

    NetCDF files or archive (tar/zip).containing netcdf files storing the target indices. (Info)

  • location (string) – Geographical coordinates (lon,lat) of the target location.

  • indices (string) – One or more climate indices to use for the comparison.

  • dist ({'seuclidean', 'nearest_neighbor', 'zech_aslan', 'kolmogorov_smirnov', 'friedman_rafsky', 'kldiv'}, optional) – Dissimilarity metric comparing distributions.

  • dateStartCandidate (dateTime, optional) – Beginning of period (YYYY-MM-DD) for candidate data. Defaults to first entry.

  • dateEndCandidate (dateTime, optional) – End of period (YYYY-MM-DD) for candidate data. Defaults to last entry.

  • dateStartTarget (dateTime, optional) – Beginning of period (YYYY-MM-DD) for target data. Defaults to first entry.

  • dateEndTarget (dateTime, optional) – End of period (YYYY-MM-DD) for target data. Defaults to last entry.

Returns

output – Dissimilarity between target at selected location and candidate distributions over the entire grid.

Return type

application/x-netcdf

References

class flyingpigeon.processes.wps_plot_spatial_analog.PlotSpatialAnalogProcess[source]

plot_spatial_analog Map of dissimilarity values calculated by the spatial_analog process. (v0.1)

Produce map showing the dissimilarity values computed by the spatial_analog process as well as indicating by a marker the location of the target site.

Parameters
  • resource (application/x-netcdf, application/x-tar, application/zip) –

    Dissimilarity between target at selected location and candidate distributions over the entire grid. (Info)

  • fmt ({'png', 'pdf', 'svg', 'ps', 'eps'}, optional) – Figure format

  • title (string, optional) – Figure title.

Returns

output_figure – Map of dissimilarity values.

Return type

image/png, application/pdf, image/svg+xml, application/postscript

References