teca_cf_reader.h

#ifndef teca_cf_reader_h
#define teca_cf_reader_h
 
#include "teca_algorithm.h"
#include "teca_metadata.h"
#include "teca_shared_object.h"
 
#include <vector>
#include <string>
 
TECA_SHARED_OBJECT_FORWARD_DECL(teca_cf_reader)
 
class teca_cf_reader_internals;
using p_teca_cf_reader_internals = std::shared_ptr<teca_cf_reader_internals>;
 
 
class teca_cf_reader : public teca_algorithm
{
public:
    TECA_ALGORITHM_STATIC_NEW(teca_cf_reader)
    TECA_ALGORITHM_DELETE_COPY_ASSIGN(teca_cf_reader)
    TECA_ALGORITHM_CLASS_NAME(teca_cf_reader)
    ~teca_cf_reader();
 
    // report/initialize to/from Boost program options
    // objects.
    TECA_GET_ALGORITHM_PROPERTIES_DESCRIPTION()
    TECA_SET_ALGORITHM_PROPERTIES()
 
    // list of file names to open. if this is set the files_regex
    // is ignored.
    TECA_ALGORITHM_VECTOR_PROPERTY(std::string, file_name)
 
    // describe the set of files comprising the dataset. This
    // should contain the full path and regex describing the
    // file name pattern. only the final component of a path
    // can contain a regex.
    TECA_ALGORITHM_PROPERTY(std::string, files_regex)
 
    // set if the dataset has periodic boundary conditions
    TECA_ALGORITHM_PROPERTY(int, periodic_in_x)
    TECA_ALGORITHM_PROPERTY(int, periodic_in_y)
    TECA_ALGORITHM_PROPERTY(int, periodic_in_z)
 
    // set the variable to use for the coordinate axes.
    // the defaults are: x => lon, y => lat, z = "",
    // t => "time". leaving z empty will result in a 2D
    // mesh.
    TECA_ALGORITHM_PROPERTY(std::string, x_axis_variable)
    TECA_ALGORITHM_PROPERTY(std::string, y_axis_variable)
    TECA_ALGORITHM_PROPERTY(std::string, z_axis_variable)
    TECA_ALGORITHM_PROPERTY(std::string, t_axis_variable)
 
    // Override the calendar and time unit. When these are specified
    // their values take precedence over the values found in the file.
    TECA_ALGORITHM_PROPERTY(std::string, t_calendar)
    TECA_ALGORITHM_PROPERTY(std::string, t_units)
 
    // a way to infer time from the filename if the time axis is not
    // stored in the file itself. std::get_time format codes are used.
    // If a calendar is not specified then the standard calendar is
    // used. If time units are not specified then the time units will
    // be "days since %Y-%m-%d 00:00:00" where Y,m, and d are computed
    // from the filename of the first file. set t_axis_variable to an
    // empty string to use.
    //
    // For example, for the list of files:
    //
    //      my_file_20170516_00.nc
    //      my_file_20170516_03.nc
    //      ...
    //
    // the template would be
    //
    //      my_file_%Y%m%d_%H.nc
    TECA_ALGORITHM_PROPERTY(std::string, filename_time_template)
 
    // an explicit list of double precision time values to use.
    // set t_axis_variable to an empty string to use.
    TECA_ALGORITHM_VECTOR_PROPERTY(double, t_value)
 
    // set/get the number of ranks used to read the time axis.
    // the default value of 1024 ranks works well on NERSC
    // Cori scratch file system and may not be optimal on
    // other systems.
    TECA_ALGORITHM_PROPERTY(int, max_metadata_ranks)
 
protected:
    teca_cf_reader();
    void clear_cached_metadata();
 
private:
    teca_metadata get_output_metadata(
        unsigned int port,
        const std::vector<teca_metadata> &input_md) override;
 
    const_p_teca_dataset execute(
        unsigned int port,
        const std::vector<const_p_teca_dataset> &input_data,
        const teca_metadata &request) override;
 
    virtual void set_modified() override;
 
private:
    std::vector<std::string> file_names;
    std::string files_regex;
    std::string x_axis_variable;
    std::string y_axis_variable;
    std::string z_axis_variable;
    std::string t_axis_variable;
    std::string t_calendar;
    std::string t_units;
    std::string filename_time_template;
    std::vector<double> t_values;
    int periodic_in_x;
    int periodic_in_y;
    int periodic_in_z;
    int max_metadata_ranks;
    p_teca_cf_reader_internals internals;
};
 
#endif