TSTool-Vol2-CommandReference - Laserfiche WebLink

Required when a IndependentTSList= *TSID Independent EnsembleID The ensemble identifier for the independent time series (see the explanation of EnsembleID). Required when IndepndentTSList= EnsembleID. SetStart The date/time to start setting data, if other than the full time series period. Full period if * is specified. SetEnd The date/time to end setting data, if other than the full time series period. Full period if * is specified. TransferHow Indicates how to transfer data: • ByDateTime – a date/time in one time series will be lined up with the other time series. • Sequentially – data from the independent will be transferred sequentially, even if the date/time does not align (used when transferring continuous data over Feb 28/29, without gaps). None – must be specified. Command Reference – SetFromTS() -2 434 TSTool Documentation SetFromTS() Command Parameter Description Default HandleMissingHow Indicates how to handle missing data in the independent time series: • IgnoreMissing – missing values in the independent time series WILL NOT be transferred to the dependent time series. • SetMissing – missing values in the independent time series WILL be transferred to the dependent time series. • SetOnlyMissingValues – only the missing values in the independent time series will be transferred, useful when a separate time series has been used to insert additional missing values. SetMissing SetDataFlags Indicates if data flags should also be transferred. True RecalcLimits Available only for monthly time series. Indicate whether the original data limits for the time series should be recalculated after the setting the time series values. Setting to True is appropriate if the independent time series provides observations consistent with the original data. False (only the values in the initial time series will be used for historical data). A sample command file to process data from the State of Colorado’s HydroBase is as follows: # 08241000 -TRINCHERA CREEK ABOVE MOUNTAIN HOME RESERVOIR 08241000.DWR.Streamflow.Month~HydroBase # 08240500 -TRINCHERA CREEK ABOVE TURNER'S RANCH 08240500.DWR.Streamflow.Month~HydroBa se SetFromTS(TSList=AllMatchingTSID,TSID="08241000.DWR.Streamflow.Month", IndependentTSList=AllMatchingTSID, IndependentTSID="08240500.DWR.Streamflow.Month", TransferHow=ByDateTime) 435 Command Reference – SetFromTS() -3 SetFromTS() Command TSTool Documentation This page is intentionally blank. Command Reference – SetFromTS() -4 436 Command Reference: SetIgnoreLEZero() Indicate whether time series data values <= zero should be ignored in historical averages Version 08.16.00, 2008-07-09 The SetIgnoreLEZero() command sets the global property that indicates whether the computation of historical averages for time series should ignore values less than or equal to zero. By default, all values (other than the missing data placeholder) are used to compute averages. This command is useful when it is appropriate to ignore zero and negative values in averages, for example in cases where zero is assigned as an observation but may influence averages inappropriately. Commands that are concerned with this issue also typically provide a parameter and therefore using this global command may not be appropriate. The following dialog is used to edit this command and illustrates the syntax of the command. SetIgnoreLEZero SetIgnoreLEZero() Command Editor The command syntax is as follows: SetIgnoreLEZero(Parameter=Value,…) Command Parameters Parameter Description Default IgnoreLEZero Indicates whether the computation of historical averages should ignore values less than or equal to zero, True or False. If this command is not used, the default is False. A sample command file is as follows: SetIgnoreLEZero(IgnoreLEZero=True) 437 Command Reference – SetIgnoreLEZero() -1 SetIgnoreLEZero() Command TSTool Documentation This page is intentionally blank. Command Reference – SetIgnoreLEZero() -2 438 Command Reference: SetIncludeMissingTS() Indicate whether missing time series should automatically be added as blank time series Version 08.16.00, 2008-07-16 The SetIncludeMissingTS() command sets the global property that indicates whether time series that cannot be found should automatically be added as a time series with missing data. By default, time series that cannot be found generate a warning. This command is useful when processing large amounts of data, to guarantee a placeholder time series even if time series are not found. For example, use the command in the early stages of work to evaluate command sequence logic without addressing every data issue, and then remove the command when focusing on data. The following dialog is used to edit this command and illustrates the syntax of the command. SetIncludeMissingTS SetIncludeMissingTS() Command Editor The command syntax is as follows: SetIncludeMissingTS(Parameter=Value, …) Command Parameters Parameter Description Default IncludeMissingTS Indicates whether time series that are not found with read commands should automatically be added with missing data. If this command is not used, the default is False. A sample command file is as follows: SetIncludeMissingTS(IncludeMissingTS=True) 439 Command Reference – SetIncludeMissingTS() -1 SetIncludeMissingTS() Command TSTool Documentation This page is intentionally blank. Command Reference –SetIncludeMissingTS() -2 440 Command Reference: SetInputPeriod() Set the period for reading time series from files and querying from databases Version 08.15.00, 2008-05-11 The SetInputPeriod() command sets the period used for reading time series data from files and querying data from databases. The default is to read/query all available data so that all data are available for analysis and data filling. However, a shorter period may be desirable to increase performance (e.g., when processing real-time data) or to force matching a historical period. This command replaces the SetQueryPeriod() command. See also the SetOutputPeriod() command. The following dialog is used to edit the command and illustrates the command syntax. SetInputPeriod SetInputPeriod() Command Editor 441 Command Reference – SetInputPeriod() -1 SetInputPeriod() Command TSTool Documentation The command syntax is as follows: SetInputPeriod(Parameter=Value,…) Command Parameters Parameter Description Default InputStart The date/time to start reading/querying time series data, one of: • A date/time string (see dialog above for examples). • CurrentToYear, CurrentToMonth, CurrentToDay, CurrentToHour, CurrentToMinute, indicating the current date/time to the specified precision. • A Current* value +-an interval, for example: CurrentToMinute – 7Day None – must be specified. InputEnd The date/time to end reading/querying time series data, one of: • A date/time string (see dialog above for examples). • CurrentToYear, CurrentToMonth, CurrentToDay, CurrentToHour, CurrentToMinute, indicating the current date/time to the specified precision. • A Current* value +-an interval, for example: CurrentToMinute – 7Day • An expression involving InputStart, used similar to the Current* values. None – must be specified. A sample commands file for historical data from the State of Colorado’s HydroBase is as follows: SetInputPeriod(InputStart="1950-01",InputEnd="2000-09") # 06754000 -SOUTH PLATTE RIVER NEAR KERSEY 06754000.DWR.Streamflow.Month~HydroBase A sample commands file for real-time data is as follows: SetInputPeriod(InputStart="CurrentToMinute -14Day", InputEnd="CurrentToMinute + 1Hour") # 06754000 -SOUTH PLATTE RIVER NEAR KERSEY 06754000.DWR.Streamflow-DISCHRG.Irregular~HydroBase Command Reference – SetInputPeriod() -2 442 Command Reference: SetOutputPeriod() Set the output period for time series Version 09.08.01, 2010-09-14 The SetOutputPeriod() command sets the output period for time series. See also the SetInputPeriod() command. The period for a time series when read or created will be set to the maximum of the following periods, in order to satisfy output and data filling requirements: • available data, • output period (if specified), • input period (if specified). Specifying the output period is necessary when creating model files or filling an extended period (time series will not automatically be extended by fill commands). The following dialog is used to edit this command and illustrates the syntax of the command. Note that the output period should always use calendar month and year, even if other than calendar year are used for output (see SetOutputYearType()). 443 Command Reference – SetOutputPeriod() -1 SetOutputPeriod() Command TSTool Documentation SetOutputPeriod SetOutputPeriod() Command Editor The command syntax is as follows: SetOutputPeriod(Parameter=Value,…) Command Parameters Parameter Description Default OutputStart The date/time to start output. None – must be specified. OutputEnd The date/time to end output. None – must be specified. A sample commands file is as follows: SetOutputPeriod(OutputStart="1950-01",OutputEnd="2002-12") Command Reference – SetOutputPeriod() -2 444 Command Reference: SetOutputYearType() Set the output year type for time series Version 10.00.01, 2011-04-18 The SetOutputYearType() command sets the global output year type for output reports and files. The default for most operations is calendar year (January through December); however, alternate year definitions may be useful. The global output year type is recognized by some common tools and commands that create output. Many write commands also allow the year type to be specified for the command. Internally, all data are managed using calendar years and are converted to different year types during output or display. The ChangeInterval() command also allows time series to be converted to annual values where the value corresponds to a year type. The year type for output and analysis theoretically can be defined in many ways. Internally, TSTool allows the start and end year to have offsets from the calendar year. This allows the output year type to have a starting year previous to the calendar year or the same as the calendar year. A convention that is being implemented over time is to prepend Year to the year types where the start of the output year agrees with the calendar year number, and append Year to the year types where the end of the output year agrees with the calendar year number. For example, YearMayToApr would indicate that the output year is May of the calendar year to Apr of the next calendar year. The following dialog is used to edit the command and illustrates the command syntax. SetOutputYearType SetOutputYearType() Command Editor 445 Command Reference – SetOutputYearType() -1 SetOutputYearType() Command TSTool Documentation The command syntax is as follows: SetOutputYearType(Parameter=Value,…) Command Parameters Parameter Description Default OutputYearType The output year type, one of: • Calendar – January through December. • NovToOct – November of the previous calendar year to October of the current calendar year. For example, year 1970 spans Nov 1969 to Oct 1970. • Water – October of the previous calendar year through September of the current calendar year (and water year). For example, water year 1970 spans Oct 1969 to Sep 1970. In the future, more generic types like NovToOct may be implemented. If this command is not specified, Calendar is the default. A sample commands file is as follows: SetOutputYearType(Out putYearType=Calendar) Command Reference – SetOutputYearType() -2 446 Command Reference: SetPatternFile() Set the pattern file to be used with FillPattern() commands Version 08.16.04, 2008-09-19 This command has been replaced with ReadPatternFile() – TSTool will automatically convert the command. The SetPatternFile() command specifies a pattern file to be used with FillPattern() commands (see the FillPattern() command for more information ). The following dialog is used to edit the command and illustrates the command syntax. SetPatternFile SetPatternFile() Command Editor The command syntax is as follows: SetPatternFile(PatternFile) Command Parameters Parameter Description Default PatternFile The path to the pattern file, which can be absolute or relative to the working directory. The Browse button can be used to select the pattern file (if a relative path is desired, remove the leading path after the select). None – must be specified. A sample commands file is as follows: SetPatternFile("fill.pat") 447 Command Reference – SetPatternFile() -1 SetPatternFile() Command TSTool Documentation This page is intentionally blank. Command Reference – SetPatternFile() -2 448 Command Reference – SetProperty() -1 Command Reference: SetProperty() Set a property for the time series processor Version 10.01.00, 2011-11-15 The SetProperty() command sets the value of a property used by the time series processor. The property will be available to subsequent commands that support using ${Property} notation in parameters, for example to specify filenames more dynamically. This command should not be confused with the SetTimeSeriesProperty() command, which sets a property on specific time series. The following dialog is used to edit this command and illustrates the syntax of the command. SetProperty SetProperty() Command Editor 449 SetProperty() Command TSTool Documentation Command Reference – SetProperty() -2 The command syntax is as follows: SetProperty(Parameter=Value,…) Command Parameters Parameter Description Default PropertyName The property name. None – must be specified. PropertyType The property type, used for validation, one of: • DateTime – a date/time. • Double – a floating point number • Integer – an integer • String – a string None – must be specified. PropertyValue The value of the property, adhering to property type constraints. Date/time properties should be specified using standard formats such as “YYYY-MM-DD hh:mm:ss”, to an appropriate precision. Special date/time syntax is recognized, as shown in the above figure. Global properties can be used with the ${Property} syntax. None – must be specified. A sample commands file is as follows: SetProperty(PropertyName="Scenario",PropertyType=String,PropertyValue="Likely") 450 Command Reference – SetTimeSeriesPropertiesFromTable() -1 Command Reference: SetTimeSeriesPropertiesFromTable() Set time series properties using values in a table Version 10.07.00, 2012-04-18 The SetTimeSeriesPropertiesFromTable() command sets user-defined time series properties using values in a table. This is useful, for example, when additional attributes are available for locations associated with time series. The time series can then be selected for processing by matching properties with the SelectTimeSeries() command. The following dialog is used to edit the command and illustrates the command syntax (in this case the location part of the time series identifier is used to match the contents of the “loc” column in the table). SetTimeSeriesPropertiesFromTable SetTimeSeriesPropertiesFromTable() Command Editor The command syntax is as follows: SetTimeSeriesPropertiesFromTable(Parameter=Value,…) 451 SetTimeSeriesPropertiesFromTable() Command TSTool Documentation Command Reference – SetTimeSeriesPropertiesFromTable() -2 Command Parameters Parameter Description Default TSList Indicates the list of time series to be processed, one of: • AllMatchingTSID – all time series that match the TSID (single TSID or TSID with wildcards) will be modified. • AllTS – all time series before the command. • EnsembleID – all time series in the ensemble will be modified (see the EnsembleID parameter). • FirstMatchingTSID – the first time series that matches the TSID (single TSID or TSID with wildcards) will be modified. • LastMatchingTSID – the last time series that matches the TSID (single TSID or TSID with wildcards) will be modified. AllTS TSID The time series identifier or alias for the time series to be modified, using the * wildcard character to match multiple time series. Required if TSList=*TSID EnsembleID The ensemble to be modified, if processing an ensemble. Required if TSList=EnsembleID TableID The identifier for the table that contains properties. None – must be specified. TableTSIDColumn Table column name that is used to match the time series identifier for processing. None – must be specified. TableTSIDFormat The specification to format the time series identifier to match the TSID column. Use the format choices and other characters to define a unique identifier. Time series alias if available, or otherwise the time series identifier. TableInputColumns The name(s) of the column(s) to supply properties for the matching time series. Separate column names with commas. None – must be specified. TSPropertyNames The names(s) of the time series properties. Separate names by commas, leave blank to use the corresponding TableInputColumns name, or use the special value TS:Description to set the time series description. Same as TableInputColumns. 452 Command Reference: SetTimeSeriesProperty() Set time series properties Version 09.09.00, 2010-09-23 The SetTimeSeriesProperty() command sets the value of time series properties. Properties that are used to uniquely identify the time series cannot be set because other commands need to utilize this information to reference the time series; therefore, properties that cannot be changed include the location identifier, data source, data type, interval, and scenario. See also the SetTimeSeriesPropertiesFromTable()and SelectTimeSeries() commands. The following dialog is used to edit this command and illustrates the syntax of the command. SetTimeSeriesProperty SetTimeSeriesProperty() Command Editor The command syntax is as follows: SetTimeSeriesProperty(Par ameter=Value,…) Command Parameters Parameter Description Default TSList Indicates the list of time series to be processed, one of: • AllMatchingTSID – all time series that match the TSID (single TSID or TSID with wildcards) will be modified. • AllTS – all time series before the command. • EnsembleID – all time series in the ensemble will be modified. • FirstMatchingTSID – the last time AllTS 453 Command Reference – SetTimeSeriesProperty() -1 SetTimeSeriesProperty() Command TSTool Documentation series that matches the TSID (single TSID or TSID with wildcards) will be modified. • LastMatchingTSID – the last time series that matches the TSID (single TSID or TSID with wildcards) will be modified. • SelectedTS – the time series are those selected with the SelectTimeSeries() command. TSID The time series identifier or alias for the time series to be modified, using the * wildcard character to match multiple time series. Required if TSList=*TSID. EnsembleID The ensemble to be modified, if processing an ensemble. Required if TSList=EnsembleID. Description The description to assign to the time series. Use the format choices and other characters to define a unique alias. None. Units The data units to assign to the time series. The units should agree with the time series data values. None. Editable If set to True, then graphing the time series will enable interactive editing features, including the ability to save the edited time series. False PropertyName Name of user-defined property. PropertyType Property type, to ensure proper initialization and data check. Required if PropertyName is specified. PropertyValue Value for property, adhering to the property type requirements. Required if PropertyName is specified. A sample command file to set a property for time series read from a StateMod file is as follows: ReadStateMod(InputFile="Data\ym2004.ddh") SetTimeSeriesProperty(Units="AF/M") Command Reference – SetTimeSeriesProperty () -2 454 Command Reference: SetToMax() Set data values to the maximum of values from one or more time series Version 08.16.04, 2008-09-25 The SetToMax() command sets a time series to contain, for each time step, the maximum of its own values and those of one or more additional (independent) time series. This command replaces the SetMax() command. See also the SetToMin() command. The following dialog is used to edit the command and illustrates the command syntax. SetToMax SetToMax() Command Editor 455 Command Reference – SetToMax() -1 SetToMax() Command TSTool Documentation The command syntax is as follows: SetToMax(Parameter=Value,…) Command Parameters Parameter Description Default TSID The time series identifier or alias for the time series to be modified. None – must be specified. IndependentTSList Indicates how the list of time series is specified, one of: • AllTS – all time series before the command. • AllMatchingTSID – all time series that match the IndependentTSID (single TSID or TSID with wildcards). • EnsembleID – the time series from the specified ensemble will be processed. • FirstMatchingTSID – the first time series that matches the TSID (single TSID or TSID with wildcards) will be processed. • LastMatchingTSID – the last time series that matches the TSID (single TSID or TSID with wildcards) will be processed. • SelectedTS – the time series are those selected with the SelectTimeSeries() command. • SpecifiedTSID – the specified list of time series given by the IndependentTSID parameter. AllTS (the time series receiving the result will not be checked) IndependentTSID If the IndependentTSList= SpecifiedTSID, provide the list of time series identifiers (or alias) to process, separated by commas. If the IndependentTSList parameter is AllMatchingTSID, FirstMatchingTSID, or LastMatchingTSID, specify a single TSID or a TSID with wildcards. Required if TSList=*TSID. Independent EnsembleID Ensemble identifier. Required if TSList=EnsembleID. A sample command file to process data from the State of Colorado’s HydroBase database is as follows: # 08236000 -ALAMOSA RIVER ABOVE TERRACE RESERVOIR 08236000.DWR.Streamflow.Month~HydroBase # 08236500 -ALAMOSA RIVER BELOW TERRACE RESERVOIR 08236500.DWR.Streamflow.Month~HydroBase SetToMax(TSID="08236000.DWR.Streamflow.Month", IndependentTSList=SpecifiedTSID, IndependentTSID="08236500.DWR.Streamflow.Month") Command Reference – SetToMax() -2 456 Command Reference: SetToMin() Set data values to the minimum of values from one or more time series Version 08.16.04, 2008-09-25 The SetToMin() command sets a time series to contain, for each time step, the minimum of its own values and those of one or more additional (independent) time series. The following dialog is used to edit the command and illustrates the command syntax. SetToMin SetToMin() Command Editor 457 Command Reference – SetToMin() -1 SetToMin() Command TSTool Documentation The command syntax is as follows: SetToMin(Parameter=Value,…) Command Parameters Parameter Description Default TSID The time series identifier or alias for the time series to be modified. None – must be specified. IndependentTSList Indicates how the list of time series is specified, one of: • AllTS – all time series before the command. • AllMatchingTSID – all time series that match the IndependentTSID (single TSID or TSID with wildcards). • EnsembleID – the time series from the specified ensemble will be processed. • FirstMatchingTSID – the first time series that matches the TSID (single TSID or TSID with wildcards) will be processed. • LastMatchingTSID – the last time series that matches the TSID (single TSID or TSID with wildcards) will be processed. • SelectedTS – the time series are those selected with the SelectTimeSeries() command. • SpecifiedTSID – the specified list of time series given by the IndependentTSID parameter. AllTS (the time series receiving the result will not be checked) IndependentTSID If the IndependentTSList= SpecifiedTSID, provide the list of time series identifiers (or alias) to process, separated by commas. If the IndependentTSList parameter is AllMatchingTSID, FirstMatchingTSID, or LastMatchingTSID, specify a single TSID or a TSID with wildcards. Required if TSList=*TSID. Independent EnsembleID Ensemble identifier. Required if TSList=EnsembleID. A sample command file to process data from the State of Colorado’s HydroBase database is as follows: # 08236000 -ALAMOSA RIVER ABOVE TERRACE RESERVOIR 08236000.DWR.Streamflow.Month~HydroBase # 08236500 -ALAMOSA RIVER BELOW TERRACE RESERVOIR 08236500.DWR.Streamflow.Month~HydroBase SetToMin(TSID="08236000.DWR.Streamflow.Month", IndependentTSList=SpecifiedTSID, IndependentTSID="08236500.DWR.Streamflow.Month") Command Reference – SetToMin() -2 458 Command Reference: SetWarningLevel() Set level for warning messages Version 08.16.00, 2008-08-24 The SetWarningLevel() command sets the warning levels for the screen and log file. Higher warning levels are useful for troubleshooting commands. The higher the level, the more messages will be generated. This command can be used multiple times, for example to isolate a problem. Currently the warning level applies to all components. In the future logging control may be grouped by component. Levels are not completely consistent but the following guidelines can be followed: 0 = no messages 1 = important messages generated in applications 2 = important messages generated in commands 3+ = messages generated in commands that may explain other problems 10+ = messages in processing code that may still be useful to end users 30+ = low-level messages, for example generated while reading from files or databases The following dialog is used to edit this command and illustrates the command syntax. SetWarningLevel SetWarningLevel() Command Editor 459 Command Reference – SetWarningLevel() -1 SetWarningLevel() Command TSTool Documentation The command syntax is as follows: SetWarningLevel(Parameter=Value,…) Command Parameters Parameter Description Default ScreenLevel The warning level for the screen (0+). Keep previous setting. LogFileLevel The warning level for the log file (0+). Keep previous setting A sample commands file is as follows: SetWarningLevel(ScreenLevel=1,LogFi leLevel=10) Command Reference – SetWarningLevel() -2 460 Command Reference: SetWorkingDir() Set working directory Version 10.00.02, 2011-05-23 The SetWorkingDir() command sets the working directory for following commands. The working directory is normally set in one of the following ways, with the current setting being defined by the most recent action that has occurred: 1. The startup directory for the TSTool program, 2. The directory containing the most recently opened or saved command file. 3. The directory specified by a SetWorkingDir() command, 4. The directory specified by File…Set Working Directory. In most cases, a SetWorkingDir() command is not needed and should be avoided because it may complicate commands and troubleshooting. However, for complicated command files that process data in multiple directories, it may be useful to change the working directory during processing. Setting the working directory to an absolute path causes all relative paths for input and output files to be appended to the working directory. Relative paths that use “../” can be specified to move up and down a directory tree. The current working directory during processing is reset to the initial working directory (the location of the command file) each time that the commands are run. In any case, it is recommended that paths used in command parameters be specified using relative paths (relative to the command file) so that command files and associated data files can be easily moved from one computer to another. The following dialog is used to edit the command and illustrates the syntax of the command. SetWorkingDir SetWorkingDir() Command Editor 461 Command Reference – SetWorkingDir() -1 SetWorkingDir() Command TSTool Documentation The command syntax is as follows: SetWorkingDir(Parameter=Value,…) Command Parameters Parameter Description Default WorkingDir The working directory that should be used. Specify a relative path (e.g., “..”) to adjust the current working directory. None – must be specified. RunMode Indicate the run mode in which the command should be applied, one of: • GUIOnly – the command applies only to interactive runs • GUIAndBatch – the command applies to interactive and batch runs • BatchOnly – the command applies to batch runs only GUIAndBatch A sample command file is as follows: SetWorkingDir(WorkingDir="C:\temp") Command Reference – SetWorkingDir() -2 462 Command Reference: ShiftTimeByInterval() Shift time series data by one or more time intervals Version 08.15.00, 2008-05-11 The ShiftTimeByInterval()command shifts a time series in time. This command can be used to perform a simple shift (e.g., to shift hourly data because the Disaggregate() command did not result in data being set at the desired hours) and to perform