WrappedPython_XArrayCFReader_XArrayCFReader.h

Go to the documentation of this file.

// Loadable modules
//
// Generated by /builds/gitlab-kitware-sciviz-ci/build/bin/vtkProcessXML-pv6.0
//
#ifndef WrappedPython_XArrayCFReader_XArrayCFReader_h
#define WrappedPython_XArrayCFReader_XArrayCFReader_h

#include <cstring>
#include <cassert>
#include <algorithm>


// From file /builds/gitlab-kitware-sciviz-ci/Plugins/XArrayCFReader/XArrayCFReader.py
static const char* const module_XArrayCFReader_XArrayCFReader_string0 =
"import os.path\n"
"from paraview.util.vtkAlgorithm import *\n"
"from vtkmodules.util.xarray_support import vtkXArrayCFReader\n"
"from vtkmodules.vtkCommonExecutionModel import vtkStreamingDemandDrivenPipeline\n"
"\n"
"@smproxy.reader(name=\"XArrayCFReader\", label=\"XArrayCF Reader\",\n"
"                extensions=\"nc h5 zgroup grib\", file_description=\"XArray files\")\n"
"class XArrayCFReader(vtkXArrayCFReader):\n"
"    '''Reads data from a file using the XArray readers and then connects\n"
"    the XArray data to the vtkNetCDFCFREader (using zero-copy when\n"
"    possible). At the moment, data is copied for coordinates (because\n"
"    they are converted to double in the reader) and for certain data\n"
"    that is subset either in XArray or in VTK.  Lazy loading in XArray\n"
"    is respected, that is data is accessed only when it is needed.\n"
"    Time is passed to VTK either as an int64 for datetime64 or\n"
"    timedelta64, or as a double (using cftime.toordinal) for cftime.\n"
"    '''\n"
"    def __init__(self):\n"
"        super().__init__()\n"
"\n"
"    @smproperty.stringvector(name=\"FileName\")\n"
"    @smdomain.filelist()\n"
"    @smhint.filechooser(extensions=\"nc,h5,zgroup,grib\", file_description=\"XArray files\")\n"
"    def SetFileName(self, name):\n"
"        \"\"\"Specify filename for the file to read.\"\"\"\n"
"        if os.path.basename(name) == '.zgroup':\n"
"            super().SetFileName(os.path.dirname(name))\n"
"        else:\n"
"            super().SetFileName(name)\n"
"\n"
"\n"
"    @smproperty.stringvector(name=\"DimensionInfo\", information_only=\"1\")\n"
"    @smdomain.xml(\"\"\"<StringArrayHelper />\"\"\")\n"
"    def GetAllDimensions(self):\n"
"        # cannot use super(). see https://stackoverflow.com/questions/12047847/super-object-not-calling-getattr\n"
"        all_dims = self._reader.GetAllDimensions()\n"
"        return all_dims\n"
"\n"
"\n"
"    @smproperty.stringvector(name=\"Dimensions\", number_of_elements=\"1\")\n"
"    @smdomain.xml(\\\n"
"        \"\"\"<StringListDomain name=\"array_list\">\n"
"                <RequiredProperties>\n"
"                    <Property name=\"DimensionInfo\" function=\"ArrayList\"/>\n"
"                </RequiredProperties>\n"
"            </StringListDomain>\n"
"        <Documentation>Load the grid with the given dimensions. Any arrays that\n"
"        conform to these dimensions will be loaded.</Documentation>\n"
"        \"\"\")\n"
"    def SetDimensions(self, dims):\n"
"        # cannot use super(). see https://stackoverflow.com/questions/12047847/super-object-not-calling-getattr\n"
"        if dims != 'None':\n"
"            self._reader.SetDimensions(dims)\n"
"            self.Modified()\n"
"\n"
"\n"
"    @smproperty.intvector(name=\"SphericalCoordinates\", number_of_elements=\"1\",\n"
"                          default_values=\"1\")\n"
"    @smdomain.xml(\\\n"
"        \"\"\"<BooleanDomain name=\"bool\" />\n"
"        <Documentation>If on, then data with latitude/longitude dimensions will\n"
"        be read in as curvilinear data shaped like spherical coordinates. If\n"
"        false, then the data will always be read in Cartesian\n"
"        coordinates.</Documentation>\n"
"        \"\"\")\n"
"    def SetSphericalCoordinates(self, spherical):\n"
"        # cannot use super(). see https://stackoverflow.com/questions/12047847/super-object-not-calling-getattr\n"
"        self._reader.SetSphericalCoordinates(spherical)\n"
"        self.Modified()\n"
"\n"
"    @smproperty.doublevector(name=\"VerticalScale\", number_of_elements=\"1\",\n"
"                             default_values=\"1\")\n"
"    @smdomain.xml(\\\n"
"        \"\"\"<DoubleRangeDomain name=\"range\" />\n"
"        <Documentation>The scale of the vertical component of spherical\n"
"        coordinates. It is common to write the vertical component with respect\n"
"        to something other than the center of the sphere (for example, the\n"
"        surface). In this case, it might be necessary to scale and/or bias the\n"
"        vertical height. The height will become height*scale + bias. Keep in\n"
"        mind that if the positive attribute of the vertical dimension is down,\n"
"        then the height is negated. The scaling will be adjusted if it results\n"
"        in invalid (negative) vertical values.</Documentation>\n"
"        \"\"\")\n"
"    def SetVerticalScale(self, scale):\n"
"        # cannot use super(). see https://stackoverflow.com/questions/12047847/super-object-not-calling-getattr\n"
"        self._reader.SetVerticalScale(scale)\n"
"        self.Modified()\n"
"\n"
"\n"
"    @smproperty.doublevector(name=\"VerticalBias\", number_of_elements=\"1\",\n"
"                             default_values=\"0\")\n"
"    @smdomain.xml(\\\n"
"        \"\"\"<DoubleRangeDomain name=\"range\" />\n"
"        <Documentation>The bias of the vertical component of spherical\n"
"        coordinates. It is common to write the vertical component with respect\n"
"        to something other than the center of the sphere (for example, the\n"
"        surface). In this case, it might be necessary to scale and/or bias the\n"
"        vertical height. The height will become height*scale + bias. Keep in\n"
"        mind that if the positive attribute of the vertical dimension is down,\n"
"        then the height is negated. The scaling will be adjusted if it results\n"
"        in invalid (negative) vertical values.</Documentation>\n"
"        \"\"\")\n"
"    def SetVerticalBias(self, bias):\n"
"        # cannot use super(). see https://stackoverflow.com/questions/12047847/super-object-not-calling-getattr\n"
"        self._reader.SetVerticalBias(bias)\n"
"        self.Modified()\n"
"\n"
"    @smproperty.intvector(name=\"ReplaceFillValueWithNan\", number_of_elements=\"1\",\n"
"                          default_values=\"0\")\n"
"    @smdomain.xml(\\\n"
"        \"\"\"<BooleanDomain name=\"bool\" />\n"
"        <Documentation>If on, any float or double variable read that has a\n"
"        _FillValue attribute will have that fill value replaced with a\n"
"        not-a-number (NaN) value. The advantage of setting these to NaN values\n"
"        is that, if implemented properly by the system and careful math\n"
"        operations are used, they can implicitly be ignored by calculations\n"
"        like finding the range of the values. That said, this option should be\n"
"        used with caution as VTK does not fully support NaN values and\n"
"        therefore odd calculations may occur.</Documentation>\n"
"        \"\"\")\n"
"    def SetReplaceFillValueWithNan(self, replace):\n"
"        # cannot use super(). see https://stackoverflow.com/questions/12047847/super-object-not-calling-getattr\n"
"        self._reader.SetReplaceFillValueWithNan(replace)\n"
"        self.Modified()\n"
"\n"
"    @smproperty.intvector(name=\"OutputType\", number_of_elements=\"1\",\n"
"                          default_values=\"-1\")\n"
"    @smdomain.xml(\\\n"
"        \"\"\"<EnumerationDomain name=\"enum\">\n"
"          <Entry text=\"Automatic\"\n"
"                 value=\"-1\" />\n"
"          <Entry text=\"Image\"\n"
"                 value=\"6\" />\n"
"          <Entry text=\"Rectilinear\"\n"
"                 value=\"3\" />\n"
"          <Entry text=\"Structured\"\n"
"                 value=\"2\" />\n"
"          <Entry text=\"Unstructured\"\n"
"                 value=\"4\" />\n"
"        </EnumerationDomain>\n"
"        <Documentation>Specifies the type of data that the reader creates. If\n"
"        Automatic, the reader will use the most appropriate grid type for the\n"
"        data read. Note that not all grid types support all data. A warning is\n"
"        issued if a mismatch occurs.</Documentation>\n"
"        \"\"\")\n"
"    def SetOutputType(self, output_type):\n"
"        # cannot use super(). see https://stackoverflow.com/questions/12047847/super-object-not-calling-getattr\n"
"        self._reader.SetOutputType(output_type)\n"
"        self.Modified()\n"
"\n"
"\n"
"    @smproperty.doublevector(name=\"TimestepValues\", information_only=\"1\", si_class=\"vtkSITimeStepsProperty\")\n"
"    def GetTimestepValues(self):\n"
"        information = self.GetOutputInformation(0)\n"
"        if information.Has(vtkStreamingDemandDrivenPipeline.TIME_STEPS()):\n"
"            times = information.Get(vtkStreamingDemandDrivenPipeline.TIME_STEPS())\n"
"            return times\n"
"        else:\n"
"            return []\n"
"\n";
// Get single string
inline char* module_XArrayCFReader_XArrayCFReader_source()
{

  const size_t len0 = strlen(module_XArrayCFReader_XArrayCFReader_string0);
  size_t len = ( 0
    + len0 );
  char* res = new char[ len + 1];
  size_t offset = 0;
  std::copy(module_XArrayCFReader_XArrayCFReader_string0, module_XArrayCFReader_XArrayCFReader_string0 + len0, res + offset); offset += len0;
  assert(offset == len);
  res[offset] = 0;
  return res;
}



#endif