purify::read_measurements Namespace Reference

Enumerations
enum class	format { vis , h5 , uvfits , ms }

Functions
utilities::vis_params	read_measurements (const std::string &name, const bool w_term=false, const stokes pol=stokes::I, const utilities::vis_units units=utilities::vis_units::lambda)
	read in single measurement file More...
utilities::vis_params	read_measurements (const std::vector< std::string > &names, const bool w_term=false, const stokes pol=stokes::I, const utilities::vis_units units=utilities::vis_units::lambda)
	read in measurements from a vector of file names More...
bool	file_exists (const std::string &path)
	check that file path exists More...
bool	dir_exists (const std::string &path)
	check that directory path exists More...

Enumeration Type Documentation

format

enum purify::read_measurements::format

strong

Enumerator
vis
h5
uvfits
ms

Definition at line 15 of file read_measurements.h.

{ vis, h5, uvfits, ms };

Function Documentation

dir_exists()

bool purify::read_measurements::dir_exists

(

const std::string &

path

)

check that directory path exists

Definition at line 140 of file read_measurements.cc.

                                       {
  struct stat buf;
  return (stat(path.c_str(), &buf) == 0 && S_ISDIR(buf.st_mode));
}

Referenced by purify::mkdir_recursive(), read_measurements(), and TEST_CASE().

file_exists()

bool purify::read_measurements::file_exists

(

const std::string &

path

)

check that file path exists

Definition at line 135 of file read_measurements.cc.

                                        {
  struct stat buf;
  return (stat(path.c_str(), &buf) == 0);
}

Referenced by read_measurements().

read_measurements() [1/2]

utilities::vis_params purify::read_measurements::read_measurements	(	const std::string &	name,
		const bool	w_term,
		const stokes	pol,
		const utilities::vis_units	units
	)

read in single measurement file

Definition at line 17 of file read_measurements.cc.

                                                                                          {
  return read_measurements(std::vector<std::string>{name}, w_term, pol, units);
}

Referenced by getInputData(), and TEST_CASE().

read_measurements() [2/2]

utilities::vis_params purify::read_measurements::read_measurements	(	const std::vector< std::string > &	names,
		const bool	w_term,
		const stokes	pol,
		const utilities::vis_units	units
	)

read in measurements from a vector of file names

Definition at line 21 of file read_measurements.cc.

                                                                                          {
  std::vector<std::string> found_files;
  format format_type = format::uvfits;
  for (t_int i = 0; i < names.size(); i++) {
    const boost::filesystem::path file_path(names.at(i));
    if (not file_exists(file_path.native())) {
      PURIFY_HIGH_LOG("Missing file will be removed from list: {}", names.at(i));
    } else {
      found_files.emplace_back(names.at(i));
      format format_check = format::uvfits;
      // checking if reading measurement set or .vis file
      std::size_t found = names.at(i).find_last_of(".");
      std::string format_string = "." + names.at(i).substr(found + 1);
      std::transform(format_string.begin(), format_string.end(), format_string.begin(), ::tolower);
      if (format_string == ".ms") {
        format_check = format::ms;
        if (not dir_exists(file_path.native()))
          throw std::runtime_error(names.at(i) +
                                   " is not a directory, as expected for a measurement set.");
      } else if (format_string == ".vis") {
        format_check = format::vis;
        if (not file_exists(file_path.native()))
          throw std::runtime_error(names.at(i) + " is not a regular file.");
      } else if (format_string == ".h5") {
        format_check = format::h5;
        if (not file_exists(file_path.native()))
          throw std::runtime_error(names.at(i) + " is not a regular file.");
      } else if (format_string == ".uvfits") {
        format_check = format::uvfits;
        if (not file_exists(file_path.native()))
          throw std::runtime_error(names.at(i) + " is not a regular file.");
      } else
        throw std::runtime_error("File extension for " + names.at(i) +
                                 " not recognised. Must be .vis, .h5, .uvfits, or .ms.");
      if (i == 0) format_type = format_check;
      if (i > 0 and (format_check != format_type))
        throw std::runtime_error("File extension is not the same for " + names.at(i) + " " +
                                 names.at(i - 1));
    }
  }
 
  if (found_files.size() == 0) throw std::runtime_error("No files found.");
  switch (format_type) {
  case (format::vis): {
    if (pol != stokes::I)
      throw std::runtime_error("Stokes I assumed for vis files, but a different type is chosen.");
    auto measurements = utilities::read_visibility(found_files, w_term);
    measurements.units = units;
    return measurements;
    break;
  }
  case (format::h5): {
#ifdef PURIFY_H5
    if (pol != stokes::I)
      throw std::runtime_error("Stokes I assumed for HDF5 files, but a different type is chosen.");
    auto measurements = utilities::read_visibility(found_files, w_term);
    measurements.units = units;
    return measurements;
    break;
#else
    throw std::runtime_error("HDF5 interface required to read h5 files.");
#endif
  }
  case (format::uvfits): {
    return pfitsio::read_uvfits(found_files, true, pol);
    break;
  }
  case (format::ms): {
#ifdef PURIFY_CASACORE
    return casa::read_measurementset(found_files, pol);
    break;
#else
    throw std::runtime_error("Casacore interface required to read a measurement set.");
#endif
  }
  default:
    throw std::runtime_error("Format not recognised.");
  }
}

References dir_exists(), file_exists(), h5, purify::I, ms, PURIFY_HIGH_LOG, purify::casa::read_measurementset(), purify::pfitsio::read_uvfits(), purify::utilities::read_visibility(), uvfits, and vis.