This class stores all setup information and writes a VieSchedpp.xml file. More...

#include <ParameterSettings.h>

Classes
struct	Contact
	contact information More...

struct	ParametersBaselines
	baseline parameters More...

struct	ParametersSources
	source parameters More...

struct	ParametersStations
	station parameters More...

Public Types
enum	Type { Type::station, Type::source, Type::satellite, Type::spacecraft, Type::baseline }
	possible setup and optimization flags More...

enum	TryToFocusOccurrency { TryToFocusOccurrency::once, TryToFocusOccurrency::perScan }
	try to focus weight increase occurrency More...

enum	TryToFocusType { TryToFocusType::additive, TryToFocusType::multiplicative }
	try to focus weight increase type More...

enum	ObservationModeProperty { ObservationModeProperty::required, ObservationModeProperty::optional }
	all possible observation mode flux information type More...

enum	ObservationModeBackup { ObservationModeBackup::minValueTimes, ObservationModeBackup::maxValueTimes, ObservationModeBackup::internalModel, ObservationModeBackup::value, ObservationModeBackup::none }
	all possible observation mode backup models More...

Public Member Functions
	ParameterSettings ()
	empty default constructor More...

void	software (const std::string &name, const std::string &version)
	software block in parameter.xml More...

void	general (const std::string &experimentName, const boost::posix_time::ptime &startTime, const boost::posix_time::ptime &endTime, bool subnetting, double subnettingAngle, bool useSubnettingPercent_otherwiseAllBut, double subnettingNumber, bool fillinmodeInfluenceOnSchedule, bool fillinmodeDuringScan, bool fillinmodeAPosteriori, int fillinmodeAPosteriori_minStations, int fillinmodeAPosteriori_minRepeat, bool idleToObservingTime, std::string idleToObservingTimeGroup, const std::vector< std::string > &stations, bool useSourcesFromParameter_otherwiseIgnore, const std::vector< std::string > &srcNames, const std::vector< std::string > &satelliteNames, const std::string &scanAlignment, const std::string &logConsole, const std::string &logFile, bool doNotObserveSourcesWithinMinRepeat, int versionOffset)
	general block in parameter.xml More...

void	created (const boost::posix_time::ptime &time, std::string name, std::string email)
	created block in VieSchedpp.xml More...

void	catalogs (const std::string &antenna, const std::string &equip, const std::string &flux, const std::string &freq, const std::string &hdpos, const std::string &loif, const std::string &mask, const std::string &modes, const std::string &position, const std::string &rec, const std::string &rx, const std::string &source, const std::string &tracks, const std::string &satellites)
	catalogs block in VieSchedpp.xml More...

void	group (Type type, ParameterGroup group)
	group defined in VieSchedpp.xml More...

const std::vector< std::string > &	getGroupMembers (Type type, std::string groupName)
	returns all members of a defined group More...

void	parameters (const std::string &name, const ParametersStations &PARA)
	write defined station parameters to VieSchedpp.xml More...

void	parameters (const std::string &name, const ParametersSources &PARA, Type type=Type::source)
	write defined source parameters to VieSchedpp.xml More...

void	parameters (const std::string &name, const ParametersBaselines &PARA)
	write defined baseline parameters to VieSchedpp.xml More...

void	setup (Type type, const ParameterSetup &setup)
	setup block in parameter.xml More...

void	stationWaitTimes (const std::string &name, unsigned int fieldSystem, unsigned int preob, unsigned int midob, unsigned int postob)
	station wait times block More...

void	stationCableWrapBuffer (const std::string &name, double axis1LowOffset, double axis1UpOffset, double axis2LowOffset, double axis2UpOffset)
	station cable wrap buffer block More...

void	skyCoverage (double influenceDistance, unsigned int influenceInterval, double maxTwinTelecopeDistance, std::string interpolationDistance, std::string interpolationTime)
	skyCoverage block in parameter.xml More...

void	weightFactor (double weight_skyCoverage, double weight_numberOfObservations, double weight_duration, double weight_averageSources, double weight_closure, unsigned int closures_max, double weight_averageStations, double weight_averageBaselines, double weight_idleTime, unsigned int intervalIdleTime, double weightDeclination, double declinationSlopeStart, double declinationSlopeEnd, double weightLowElevation, double lowElevationSlopeStart, double lowElevationSlopeEnd)
	weightFactor block in parameter.xml More...

void	conditions (std::vector< std::string > members, std::vector< int > minScans, std::vector< int > minBaselines, bool andForCombination, int maxNumberOfIterations, int numberOfGentleSourceReductions, int minNumberOfSourcesToReduce, double percentage)
	conditions block in paramter.xml More...

void	mode (double sampleRate, unsigned int bits, double efficiencyFactor=-1)
	custom mode block in parameter.xml More...

void	mode (const std::string &skdMode)
	mode block in parameter.xml More...

void	mode (const boost::property_tree::ptree &obsMode)
	custom observing mode to parameter.xml file More...

void	mode_band (const std::string &name, double wavelength, unsigned int channels)
	band sub-block in mode block in parameter.xml More...

void	mode_bandPolicy (const std::string &name, double minSNR, ObservationModeProperty station, ObservationModeBackup stationBackup, double stationBackupValue, ObservationModeProperty source, ObservationModeBackup sourceBackup, double sourceBackupValue)
	bandPolicy sub-block in mode block in parameter.xml More...

void	multisched (const boost::property_tree::ptree &multiSched, const std::string &number, int maxn, const std::string &useSeed, int seed, bool pick_random=false)
	multisched block in parameter.xml More...

void	mulitsched_genetic (int maxIterations, int populationSize, double selectBest, double selectRandom, double mutation, double minMutation, int parents)
	multisched block in parameter.xml More...

void	multiCore (const std::string &threads, int nThreadsManual, const std::string &jobScheduler, int chunkSize)
	multiCore multi core support for scheduling More...

void	write (const std::string &name)
	output routine that produces .xml file More...

void	output (const std::string &experimentDescription, const std::string &scheduler, const std::string &correlator, const std::string &notes, bool initializer, bool iteration_log, bool createSummary, bool createNGS, const std::string &NGS_directory, bool createSKD, bool createVex, bool createSnrTable, bool operNotes, bool srcGrp, const std::vector< std::string > &srcGroupsForStatistic, bool createSkyCoverage, const std::vector< Contact > &contacts)
	output block in parameter.xml More...

void	ruleScanSequence (unsigned int cadence, const std::vector< unsigned int > &modulo, const std::vector< std::string > &member)
	specify the sequence in which sources should be observed More...

void	ruleFocusCorners (int cadence)
	focus observations at the corners of the commonly visible sky (for intensives) More...

void	calibratorBlock (const std::vector< CalibratorBlock > &blocks)
	define fringe finder block More...

void	ruleCalibratorBlockTime (unsigned int cadence, const std::string &member, const std::vector< std::pair< double, double >> &between_elevation, unsigned int nMaxScans, unsigned int scanTime)
	calibrator block in paramters.xml More...

void	ruleCalibratorBlockNScanSelections (unsigned int cadence, const std::string &member, const std::vector< std::pair< double, double >> &between_elevation, unsigned int nMaxScans, unsigned int scanTime)
	calibrator block in paramters.xml More...

void	highImpactAzEl (const std::vector< std::string > &members, const std::vector< double > &azs, const std::vector< double > &els, const std::vector< double > &margins, int interval, int repeat)
	high impact block in VieSchedpp.xml file More...

void	simulator (const boost::property_tree::ptree &tree)
	adds simulator settings to xml file More...

void	solver (const boost::property_tree::ptree &tree)
	adds solver settings to xml file More...

void	priorities (const boost::property_tree::ptree &tree)
	adds priorities settings to xml file More...

const std::map< std::string, std::vector< std::string > > &	getGroupStations () const
	get station groups More...

const std::map< std::string, std::vector< std::string > > &	getGroupSources () const
	get source groups More...

const std::map< std::string, std::vector< std::string > > &	getGroupSatellites () const
	get satellite groups More...

const std::map< std::string, std::vector< std::string > > &	getGroupSpacecrafts () const
	get spacecraft groups More...

const std::map< std::string, std::vector< std::string > > &	getGroupBaselines () const
	get baseline groups More...

const std::map< std::string, ParametersStations > &	getParaStations () const
	get all station parameters More...

const std::map< std::string, ParametersSources > &	getParaSources () const
	get all source parameters More...

const std::map< std::string, ParametersBaselines > &	getParaBaselines () const
	get baseline parameters More...

void	addAPrioriScans (const boost::property_tree::ptree &tree, const std::string &prefix)
	adds a priori scans More...

Static Public Member Functions
static boost::property_tree::ptree	parameterStation2ptree (const std::string &name, const ParametersStations &PARA)
	defined station parameters More...

static std::pair< std::string, ParametersStations >	ptree2parameterStation (boost::property_tree::ptree ptree)
	transforms parameterStations to property_tree More...

static boost::property_tree::ptree	parameterSource2ptree (const std::string &name, const ParametersSources &PARA)
	defined source parameters More...

static std::pair< std::string, ParametersSources >	ptree2parameterSource (boost::property_tree::ptree ptree)
	transforms parameterSource to property_tree More...

static boost::property_tree::ptree	parameterBaseline2ptree (const std::string &name, const ParametersBaselines &PARA)
	defined baseline parameters More...

static std::pair< std::string, ParametersBaselines >	ptree2parameterBaseline (boost::property_tree::ptree ptree)
	transforms ParametersBaselines to property_tree More...

Private Member Functions
boost::property_tree::ptree	getChildTree (const ParameterSetup &setup)
	returns a child tree of root setup object More...

void	addContact (const Contact &contact, boost::property_tree::ptree &tree, const std::string &node)
	add contact information to xml tree More...

Contact	readContact (const boost::property_tree::ptree &tree)
	read contact information from xml tree More...

Private Attributes
boost::property_tree::ptree	master_
	master property tree More...

std::map< std::string, std::vector< std::string > >	groupStations_
	defined station group More...

std::map< std::string, std::vector< std::string > >	groupSources_
	defined source group More...

std::map< std::string, std::vector< std::string > >	groupSatellites_
	defined satellite group More...

std::map< std::string, std::vector< std::string > >	groupSpacecrafts_
	defined spacecraft group More...

std::map< std::string, std::vector< std::string > >	groupBaselines_
	defined baseline group More...

std::map< std::string, ParametersStations >	paraStations_
	defined station parameters More...

std::map< std::string, ParametersSources >	paraSources_
	defined source parameters More...

std::map< std::string, ParametersSources >	paraSatellites_
	defined satellite parameters More...

std::map< std::string, ParametersSources >	paraSpacecrafts_
	defined spacecraft parameters More...

std::map< std::string, ParametersBaselines >	paraBaselines_
	defined baseline parameters More...

Detailed Description

This class stores all setup information and writes a VieSchedpp.xml file.

Author: Matthias Schartner

Date: 22.08.2017

Member Enumeration Documentation

enum VieVS::ParameterSettings::ObservationModeBackup

strong

all possible observation mode backup models

Author: Matthias Schartner

Enumerator
minValueTimes	use minimum value found in other bands times a factor
maxValueTimes	use maximum value found in other bands times a factor
internalModel	use internal model to derive flux density of sources (sources only)
value	use specific value
none	no backup model

enum VieVS::ParameterSettings::ObservationModeProperty

strong

all possible observation mode flux information type

Author: Matthias Schartner

Enumerator

required

this band information is required. If this information is missing this object is not used.

optional

interpolated

this band information is only optional. If information is available it is used, otherwise it is

enum VieVS::ParameterSettings::TryToFocusOccurrency

strong

try to focus weight increase occurrency

Author: Matthias Schartner

Enumerator
once	increase weight only once
perScan	increadse weight after each scan

enum VieVS::ParameterSettings::TryToFocusType

strong

try to focus weight increase type

Author: Matthias Schartner

Enumerator
additive	add weight increase value
multiplicative	multiply with weight increase value

enum VieVS::ParameterSettings::Type

strong

possible setup and optimization flags

Author: Matthias Schartner

Enumerator
station	stations wise
source	source wise
satellite	satellite wise
spacecraft
baseline	spacecraft wise baseline wise

Constructor & Destructor Documentation

VieVS::ParameterSettings::ParameterSettings ( )

empty default constructor

Author: Matthias Schartner

Member Function Documentation

void ParameterSettings::addAPrioriScans	(	const boost::property_tree::ptree &	tree,
		const std::string &	prefix
	)

adds a priori scans

Author: Matthias Schartner

Parameters

tree	xml tree containing scans
prefix	prefix where property tree should be inserted

Here is the caller graph for this function:

void ParameterSettings::addContact	(	const Contact &	contact,
		boost::property_tree::ptree &	tree,
		const std::string &	node
	)

private

add contact information to xml tree

Author: Matthias Schartner

Parameters

contact	contact information
tree	xml tree
node	node where contact information should be added

void ParameterSettings::calibratorBlock ( const std::vector< CalibratorBlock > & blocks )

define fringe finder block

Author: Matthias Schartner

Parameters

blocks list of all calibration blocks

void ParameterSettings::catalogs	(	const std::string &	antenna,
		const std::string &	equip,
		const std::string &	flux,
		const std::string &	freq,
		const std::string &	hdpos,
		const std::string &	loif,
		const std::string &	mask,
		const std::string &	modes,
		const std::string &	position,
		const std::string &	rec,
		const std::string &	rx,
		const std::string &	source,
		const std::string &	tracks,
		const std::string &	satellites
	)

catalogs block in VieSchedpp.xml

Author: Matthias Schartner

Parameters

antenna	antenna catalog name
equip	equip catalog name
flux	flux catalog name
freq	freq catalog name
hdpos	hdpos catalog name
loif	loif catalog name
mask	mask catalog name
modes	modes catalog name
position	position catalog name
rec	rec catalog name
rx	rx catlog name
source	source catalog name
tracks	tracks catalog name
satellites	satellite TLE file

void ParameterSettings::conditions	(	std::vector< std::string >	members,
		std::vector< int >	minScans,
		std::vector< int >	minBaselines,
		bool	andForCombination,
		int	maxNumberOfIterations,
		int	numberOfGentleSourceReductions,
		int	minNumberOfSourcesToReduce,
		double	percentage
	)

conditions block in paramter.xml

Author: Matthias Schartner

Parameters

members	group, source name or "__all__"
minScans	minimum number of scans
minBaselines	minimum number of observations
andForCombination	combination model
maxNumberOfIterations	maximum number of iterations
numberOfGentleSourceReductions	number of gentle source reductions
minNumberOfSourcesToReduce	minimum number of sources to reduce
percentage	percentage of sources to reduce during gentle source reduction

void ParameterSettings::created	(	const boost::posix_time::ptime &	time,
		std::string	name,
		std::string	email
	)

created block in VieSchedpp.xml

Author: Matthias Schartner

Parameters

time	created time stamp
name	created name
email	created email

void ParameterSettings::general	(	const std::string &	experimentName,
		const boost::posix_time::ptime &	startTime,
		const boost::posix_time::ptime &	endTime,
		bool	subnetting,
		double	subnettingAngle,
		bool	useSubnettingPercent_otherwiseAllBut,
		double	subnettingNumber,
		bool	fillinmodeInfluenceOnSchedule,
		bool	fillinmodeDuringScan,
		bool	fillinmodeAPosteriori,
		int	fillinmodeAPosteriori_minStations,
		int	fillinmodeAPosteriori_minRepeat,
		bool	idleToObservingTime,
		std::string	idleToObservingTimeGroup,
		const std::vector< std::string > &	stations,
		bool	useSourcesFromParameter_otherwiseIgnore,
		const std::vector< std::string > &	srcNames,
		const std::vector< std::string > &	satelliteNames,
		const std::string &	scanAlignment,
		const std::string &	logConsole,
		const std::string &	logFile,
		bool	doNotObserveSourcesWithinMinRepeat,
		int	versionOffset
	)

general block in parameter.xml

Author: Matthias Schartner

Parameters

experimentName	experiment name
startTime	session start time
endTime	session end time
subnetting	flag if subnetting is allowed
subnettingAngle	minimum angular distance between subnetting sources in degrees
useSubnettingPercent_otherwiseAllBut	flag to choose minimum number of stations per subnetting scan model
subnettingNumber	value for minimum number of stations per subnetting scan model
fillinmodeInfluenceOnSchedule	flag if fillin mode scans should have an influence on the schedule
fillinmodeDuringScan	flag if fillin mode scans are allowed
fillinmodeAPosteriori	flag if fillin mode a posterior scans are allowed
fillinmodeAPosteriori_minStations	override source parameter "minStations" otherwise -1
fillinmodeAPosteriori_minRepeat	override source parameter "minRepeat" otherwise -1
idleToObservingTime	flag if idle time should be converted to observing time
idleToObservingTimeGroup	station group for idle time to observing time
stations	list of all stations
useSourcesFromParameter_otherwiseIgnore	flag which model is used for srcNames
srcNames	source names for model from useSourcesFromParameter_otherwiseIgnore
satelliteNames	names of satellites that should be scheduled
scanAlignment	scan alignment flag
logConsole	log level for console
logFile	log level for file
doNotObserveSourcesWithinMinRepeat	consider scans (with reduced weight) if they are within min repeat time
versionOffset	version offset

boost::property_tree::ptree ParameterSettings::getChildTree ( const ParameterSetup & setup )

private

returns a child tree of root setup object

Author: Matthias Schartner

Parameters

setup root setup object

Returns: child property tree

Here is the call graph for this function:

const std::map<std::string, std::vector<std::string> >& VieVS::ParameterSettings::getGroupBaselines ( ) const

inline

get baseline groups

Author: Matthias Schartner

Returns: all baseline groups

const std::vector< std::string > & ParameterSettings::getGroupMembers	(	ParameterSettings::Type	type,
		std::string	groupName
	)

returns all members of a defined group

Author: Matthias Schartner

Parameters

type	group type
groupName	group name

Returns: list of all group members

const std::map<std::string, std::vector<std::string> >& VieVS::ParameterSettings::getGroupSatellites ( ) const

inline

get satellite groups

Author: Matthias Schartner

Returns: all satellite groups

const std::map<std::string, std::vector<std::string> >& VieVS::ParameterSettings::getGroupSources ( ) const

inline

get source groups

Author: Matthias Schartner

Returns: all source groups

const std::map<std::string, std::vector<std::string> >& VieVS::ParameterSettings::getGroupSpacecrafts ( ) const

inline

get spacecraft groups

Author: Matthias Schartner

Returns: all spacecraft groups

const std::map<std::string, std::vector<std::string> >& VieVS::ParameterSettings::getGroupStations ( ) const

inline

get station groups

Author: Matthias Schartner

Returns: all station groups

const std::map<std::string, ParametersBaselines>& VieVS::ParameterSettings::getParaBaselines ( ) const

inline

get baseline parameters

Author: Matthias Schartner

Returns: all baseline parameters and name

Here is the call graph for this function:

const std::map<std::string, ParametersSources>& VieVS::ParameterSettings::getParaSources ( ) const

inline

get all source parameters

Author: Matthias Schartner

Returns: all source parameters and name

const std::map<std::string, ParametersStations>& VieVS::ParameterSettings::getParaStations ( ) const

inline

get all station parameters

Author: Matthias Schartner

Returns: all station parameters and name

void ParameterSettings::group	(	ParameterSettings::Type	type,
		ParameterGroup	group
	)

group defined in VieSchedpp.xml

Author: Matthias Schartner

Parameters

type	group type
group	group object

void ParameterSettings::highImpactAzEl	(	const std::vector< std::string > &	members,
		const std::vector< double > &	azs,
		const std::vector< double > &	els,
		const std::vector< double > &	margins,
		int	interval,
		int	repeat
	)

high impact block in VieSchedpp.xml file

Author: Matthias Schartner

Parameters

members	high impact stations
azs	target azimuths in degrees
els	target elevations in degrees
margins	target azimuth, elevation margins in degrees
interval	check interval in seconds
repeat	minimum amount of time between tow scans in seconds

void ParameterSettings::mode	(	double	sampleRate,
		unsigned int	bits,
		double	efficiencyFactor = `-1`
	)

custom mode block in parameter.xml

Author: Matthias Schartner

Parameters

sampleRate	sample rate
bits	bits
efficiencyFactor	recording efficiency factor (use -1 for internal calculation)

void ParameterSettings::mode ( const std::string & skdMode )

mode block in parameter.xml

Author: Matthias Schartner

Parameters

skdMode name of observing mode in skd catalogs

void ParameterSettings::mode ( const boost::property_tree::ptree & obsMode )

custom observing mode to parameter.xml file

Author: Matthias Schartner

Parameters

obsMode custom observing mode property tree

void ParameterSettings::mode_band	(	const std::string &	name,
		double	wavelength,
		unsigned int	channels
	)

band sub-block in mode block in parameter.xml

Author: Matthias Schartner

Parameters

name	band name
wavelength	band wavelength
channels	number of channels

void ParameterSettings::mode_bandPolicy	(	const std::string &	name,
		double	minSNR,
		ObservationModeProperty	station,
		ObservationModeBackup	stationBackup,
		double	stationBackupValue,
		ObservationModeProperty	source,
		ObservationModeBackup	sourceBackup,
		double	sourceBackupValue
	)

bandPolicy sub-block in mode block in parameter.xml

Author: Matthias Schartner

Parameters

name	band name
minSNR	minimum signal to noise ratio
station	station policy for this band
stationBackup	station backup model
stationBackupValue	station backup model value
source	source policy for this band
sourceBackup	source backup model
sourceBackupValue	source backup model value

void ParameterSettings::mulitsched_genetic	(	int	maxIterations,
		int	populationSize,
		double	selectBest,
		double	selectRandom,
		double	mutation,
		double	minMutation,
		int	parents
	)

multisched block in parameter.xml

Author: Matthias Schartner

Parameters

maxIterations	maximum number of evolutions
populationSize	population size after crossover
selectBest	percentage of best parents to select
selectRandom	percentage of random parents to select
mutation	mutation acceleration
minMutation	minimum mutation
parents	number of parents for crossover

void ParameterSettings::multiCore	(	const std::string &	threads,
		int	nThreadsManual,
		const std::string &	jobScheduler,
		int	chunkSize
	)

multiCore multi core support for scheduling

Author: Matthias Schartner

Parameters

threads	thread creation schema
nThreadsManual	number of manually selected threads
jobScheduler	job scheduling algorithmus
chunkSize	job scheduling chunk size

void ParameterSettings::multisched	(	const boost::property_tree::ptree &	multiSched,
		const std::string &	number,
		int	maxn,
		const std::string &	useSeed,
		int	seed,
		bool	pick_random = `false`
	)

multisched block in parameter.xml

Author: Matthias Schartner

Parameters

multiSched	multisched xml tree
number	maximum number of schedules model ("all" or "select")
maxn	maximum number of schedules number
useSeed	use seed model ("random" or "select")
seed	number
pick_random	default is false

void ParameterSettings::output	(	const std::string &	experimentDescription,
		const std::string &	scheduler,
		const std::string &	correlator,
		const std::string &	notes,
		bool	initializer,
		bool	iteration_log,
		bool	createSummary,
		bool	createNGS,
		const std::string &	NGS_directory,
		bool	createSKD,
		bool	createVex,
		bool	createSnrTable,
		bool	operNotes,
		bool	srcGrp,
		const std::vector< std::string > &	srcGroupsForStatistic,
		bool	createSkyCoverage,
		const std::vector< Contact > &	contacts
	)

output block in parameter.xml

Author: Matthias Schartner

Parameters

experimentDescription	experiment description
scheduler	scheduler
correlator	correlator
notes	schedule notes
initializer	create initializer
iteration_log	iteration log file
createSummary	create summary file
createNGS	create NGS file
NGS_directory	path to NGS output (empty string for default path)
createSKD	create SKD file
createVex	create VEX file
createSnrTable	create SNR table
operNotes	create operation notes file
srcGrp	create source group statistics file
srcGroupsForStatistic	groups for source group statistics file
createSkyCoverage	create sky coverage file
contacts	list of contacts

boost::property_tree::ptree ParameterSettings::parameterBaseline2ptree	(	const std::string &	name,
		const ParametersBaselines &	PARA
	)

static

defined baseline parameters

Author: Matthias Schartner

Parameters

name	parameter name
PARA	parameters

Returns: property tree with baseline parameters

void ParameterSettings::parameters	(	const std::string &	name,
		const ParametersStations &	PARA
	)

write defined station parameters to VieSchedpp.xml

Author: Matthias Schartner

Parameters

name	parameter name
PARA	parameters

void ParameterSettings::parameters	(	const std::string &	name,
		const ParametersSources &	PARA,
		Type	type = `Type::source`
	)

write defined source parameters to VieSchedpp.xml

Author: Matthias Schartner

Parameters

name	parameter name
PARA	parameters

void ParameterSettings::parameters	(	const std::string &	name,
		const ParametersBaselines &	PARA
	)

write defined baseline parameters to VieSchedpp.xml

Author: Matthias Schartner

Parameters

name	parameter name
PARA	parameters

boost::property_tree::ptree ParameterSettings::parameterSource2ptree	(	const std::string &	name,
		const ParametersSources &	PARA
	)

static

defined source parameters

Author: Matthias Schartner

Parameters

name	parameter name
PARA	parameters

Returns: property tree with source parameters

boost::property_tree::ptree ParameterSettings::parameterStation2ptree	(	const std::string &	name,
		const ParametersStations &	PARA
	)

static

defined station parameters

Author: Matthias Schartner

Parameters

name	parameter name
PARA	parameters

Returns: property tree with station parameters

void ParameterSettings::priorities ( const boost::property_tree::ptree & tree )

adds priorities settings to xml file

Author: Matthias Schartner

Parameters

tree	property tree with priorities settings

std::pair< string, ParameterSettings::ParametersBaselines > ParameterSettings::ptree2parameterBaseline ( boost::property_tree::ptree ptree )

static

transforms ParametersBaselines to property_tree

Author: Matthias Schartner

Parameters

ptree property tree

Returns: first entry is parameter name, second are baseline parameters

Here is the caller graph for this function:

std::pair< string, ParameterSettings::ParametersSources > ParameterSettings::ptree2parameterSource ( boost::property_tree::ptree ptree )

static

transforms parameterSource to property_tree

Author: Matthias Schartner

Parameters

ptree property tree

Returns: first entry is parameter name, second are source parameters

Here is the caller graph for this function:

std::pair< string, ParameterSettings::ParametersStations > ParameterSettings::ptree2parameterStation ( boost::property_tree::ptree ptree )

static

transforms parameterStations to property_tree

Author: Matthias Schartner

Parameters

ptree property tree

Returns: first entry is parameter name, second are station parameters

Here is the caller graph for this function:

VieVS::ParameterSettings::Contact ParameterSettings::readContact ( const boost::property_tree::ptree & tree )

private

read contact information from xml tree

Author: Matthias Schartner

Parameters

tree	xml tree with contact information

void ParameterSettings::ruleCalibratorBlockNScanSelections	(	unsigned int	cadence,
		const std::string &	member,
		const std::vector< std::pair< double, double >> &	between_elevation,
		unsigned int	nMaxScans,
		unsigned int	scanTime
	)

calibrator block in paramters.xml

Author: Matthias Schartner

Parameters

cadence	cadence in number of scans
member	calibrator source name
between_elevation	target elevations
nMaxScans	maximum number of scans
scanTime	fixed scan time

void ParameterSettings::ruleCalibratorBlockTime	(	unsigned int	cadence,
		const std::string &	member,
		const std::vector< std::pair< double, double >> &	between_elevation,
		unsigned int	nMaxScans,
		unsigned int	scanTime
	)

calibrator block in paramters.xml

Author: Matthias Schartner

Parameters

cadence	cadence in seconds
member	calibrator source name
between_elevation	target elevations
nMaxScans	maximum number of scans
scanTime	fixed scan time

void ParameterSettings::ruleFocusCorners ( int cadence )

focus observations at the corners of the commonly visible sky (for intensives)

Author: Matthias Schartner

Parameters

cadence cadence for focusing on one corner

void ParameterSettings::ruleScanSequence	(	unsigned int	cadence,
		const std::vector< unsigned int > &	modulo,
		const std::vector< std::string > &	member
	)

specify the sequence in which sources should be observed

Author: Matthias Schartner

If you say cadence = 5, modulo = 0, source = A than every 5th selected scan(or subnetting sequence) will be (if possible) to a source of A. This does not effect the first scan of a schedule!

You can use the modulo number to to combine different rules: cadence = 10, modulo = 0, source = "1234+567" and cadence = 10, modulo = 1, source = "1234+568" means that every 10th scan will be (if possible) to source 1234+567 followed by a scan to "1234+568".

Parameters

cadence	cadence for this rule
modulo	modulo operator for number of scan and cadence
member	source(group) which should be observed

void ParameterSettings::setup	(	ParameterSettings::Type	type,
		const ParameterSetup &	setup
	)

setup block in parameter.xml

Author: Matthias Schartner

Parameters

type	flag where this setup belongs
setup	setup object

void ParameterSettings::simulator ( const boost::property_tree::ptree & tree )

adds simulator settings to xml file

Author: Matthias Schartner

Parameters

tree	property tree with simulator settings

void ParameterSettings::skyCoverage	(	double	influenceDistance,
		unsigned int	influenceInterval,
		double	maxTwinTelecopeDistance,
		std::string	interpolationDistance,
		std::string	interpolationTime
	)

skyCoverage block in parameter.xml

Author: Matthias Schartner

Parameters

influenceDistance	maximum angular influence distance in degrees
influenceInterval	maximum time influence distance in seconds
maxTwinTelecopeDistance	maximum distance between twin telescopes
interpolationDistance	distance model function
interpolationTime	time model function

void ParameterSettings::software	(	const std::string &	name,
		const std::string &	version
	)

software block in parameter.xml

Author: Matthias Schartner

Parameters

name	software name
version	software version

void ParameterSettings::solver ( const boost::property_tree::ptree & tree )

adds solver settings to xml file

Author: Matthias Schartner

Parameters

tree	property tree with solver settings

void ParameterSettings::stationCableWrapBuffer	(	const std::string &	name,
		double	axis1LowOffset,
		double	axis1UpOffset,
		double	axis2LowOffset,
		double	axis2UpOffset
	)

station cable wrap buffer block

Author: Matthias Schartner

Parameters

name	group, station name or "__all__"
axis1LowOffset	axis 1 lower offset in degrees
axis1UpOffset	axis 1 upper offset in degrees
axis2LowOffset	axis 2 lower offset in degrees
axis2UpOffset	axis 2 upper offset in degrees

void ParameterSettings::stationWaitTimes	(	const std::string &	name,
		unsigned int	fieldSystem,
		unsigned int	preob,
		unsigned int	midob,
		unsigned int	postob
	)

station wait times block

Author: Matthias Schartner

Parameters

name	group, station name or "__all__"
fieldSystem	time for field system commands in seconds
preob	time for preob in seconds
midob	extra midob time for correlator synchronization
postob	time for postob

void ParameterSettings::weightFactor	(	double	weight_skyCoverage,
		double	weight_numberOfObservations,
		double	weight_duration,
		double	weight_averageSources,
		double	weight_closure,
		unsigned int	closures_max,
		double	weight_averageStations,
		double	weight_averageBaselines,
		double	weight_idleTime,
		unsigned int	intervalIdleTime,
		double	weightDeclination,
		double	declinationSlopeStart,
		double	declinationSlopeEnd,
		double	weightLowElevation,
		double	lowElevationSlopeStart,
		double	lowElevationSlopeEnd
	)

weightFactor block in parameter.xml

Author: Matthias Schartner

Parameters

weight_skyCoverage	weight of sky Coverage
weight_numberOfObservations	weight of number of observations
weight_duration	weight of duration of the scan
weight_averageSources	weight of an average source observation distribution
weight_closure	weight for number of closures
closures_max	max number of closures assumed to be significant
weight_averageStations	weight of an average station usage distribution
weight_averageBaselines	weight of an average baselines usage distribution
weight_idleTime	extra weight for station after long idle time
intervalIdleTime	extra weight for stations after long idle time model in seconds
weightDeclination	weight factor for declination
declinationSlopeStart	start declination of additional weight (everything above has factor 0)
declinationSlopeEnd	end declination of additional declination weight slope (everything below has factor 1)
weightLowElevation	weight factor for low elevation scans
lowElevationSlopeStart	start elevation of additional weight (everything above has factor 0)
lowElevationSlopeEnd	end elevation of additional declination weight slope (everything below has factor 1)

void ParameterSettings::write ( const std::string & name )

output routine that produces .xml file

Author: Matthias Schartner

Parameters

name	output file name (usually "parameter")

Member Data Documentation

std::map<std::string, std::vector<std::string> > VieVS::ParameterSettings::groupBaselines_

private

defined baseline group

std::map<std::string, std::vector<std::string> > VieVS::ParameterSettings::groupSatellites_

private

defined satellite group

std::map<std::string, std::vector<std::string> > VieVS::ParameterSettings::groupSources_

private

defined source group

std::map<std::string, std::vector<std::string> > VieVS::ParameterSettings::groupSpacecrafts_

private

defined spacecraft group

std::map<std::string, std::vector<std::string> > VieVS::ParameterSettings::groupStations_

private

defined station group

boost::property_tree::ptree VieVS::ParameterSettings::master_

private

master property tree

std::map<std::string, ParametersBaselines> VieVS::ParameterSettings::paraBaselines_

private

defined baseline parameters

std::map<std::string, ParametersSources> VieVS::ParameterSettings::paraSatellites_

private

defined satellite parameters

std::map<std::string, ParametersSources> VieVS::ParameterSettings::paraSources_

private

defined source parameters

std::map<std::string, ParametersSources> VieVS::ParameterSettings::paraSpacecrafts_

private

defined spacecraft parameters

std::map<std::string, ParametersStations> VieVS::ParameterSettings::paraStations_

private

defined station parameters

The documentation for this class was generated from the following files:

/home/travis/build/TUW-VieVS/VieSchedpp/XML/ParameterSettings.h
/home/travis/build/TUW-VieVS/VieSchedpp/XML/ParameterSettings.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation