#!/usr/bin/python3
"""Convert and print a list of array element positions in different coordinate systems.
Description
-----------
Convert array element positions in different CTAO coordinate systems.
Available coordinate systems are:
1. UTM system
2. ground system (similar to sim_telarray system with x-axis pointing toward geographic north
and y-axis pointing towards the west); altitude relative to the CORSIKA observation level.
Altitude is the height of the elevation rotation axis (plus some possible mirror offset).
3. Mercator system
Command line arguments
----------------------
input (str)
File name with list of array element positions.
Input can be given as astropy table file (ecsv) or a single array element in
a json file.
print (str)
Print in requested coordinate system; possible are ground, utm, mercator
export (str)
Export array element list to file in requested coordinate system;
possible are ground, utm, mercator
select_assets (str)
Select a subset of array elements / telescopes (e.g., MSTN, LSTN)
Example
-------
Convert a list of array elements using a list of telescope positions in UTM coordinates.
.. code-block:: console
simtools-convert-geo-coordinates-of-array-elements
--input tests/resources/telescope_positions-North-utm.ecsv
--print ground
The converted list of telescope positions in ground coordinates is printed to the screen.
The following example converts a list of telescope positions in UTM coordinates
and writes the output to a file in ground (sim_telarray) coordinates. Also selects
only a subset of the array elements (telescopes; ignore calibration devices):
.. code-block:: console
simtools-convert-geo-coordinates-of-array-elements
--input tests/resources/telescope_positions-North-utm.ecsv
--export ground
--select_assets LSTN
Expected output is a ecsv file in the directory printed to the screen.
"""
import logging
from pathlib import Path
import simtools.data_model.model_data_writer as writer
import simtools.utils.general as gen
from simtools.configuration import configurator
from simtools.data_model.metadata_collector import MetadataCollector
from simtools.layout import array_layout
def _parse(label=None, description=None):
"""
Parse command line configuration.
Parameters
----------
label: str
Label describing application.
description: str
Description of application.
Returns
-------
CommandLineParser
Command line parser object
"""
config = configurator.Configurator(label=label, description=description)
config.parser.add_argument(
"--input",
help="list of array element positions",
required=True,
)
config.parser.add_argument(
"--input_meta",
help="meta data file associated to input data",
type=str,
required=False,
)
config.parser.add_argument(
"--print",
help="print list of positions in requested coordinate system",
required=False,
default="",
choices=[
"ground",
"utm",
"mercator",
],
)
config.parser.add_argument(
"--export",
help="export array element list to file (in requested coordinate system)",
required=False,
default=None,
choices=[
"ground",
"utm",
"mercator",
],
)
config.parser.add_argument(
"--select_assets",
help="select a subset of assets (e.g., MSTN, LSTN)",
required=False,
default=None,
nargs="+",
)
config.parser.add_argument(
"--skip_input_validation",
help="skip input data validation against schema",
default=False,
required=False,
action="store_true",
)
return config.initialize(
output=True, require_command_line=True, db_config=True, simulation_model=["version", "site"]
)
[docs]
def main():
"""Print a list of array elements."""
label = Path(__file__).stem
data_model_name = "array_coordinates"
args_dict, db_config = _parse(
label,
description=f"Print a list of array element positions ({data_model_name})",
)
logger = logging.getLogger()
logger.setLevel(gen.get_log_level_from_user(args_dict["log_level"]))
json_type = args_dict.get("input", "").endswith(".json")
# simplified metadata treatment for model parameter json files
if json_type:
site = args_dict.get("site", None)
top_level_meta = None
validate_schema_file = None
else:
metadata = MetadataCollector(args_dict=args_dict, data_model_name=data_model_name)
site = metadata.get_site(from_input_meta=True)
top_level_meta = metadata.top_level_meta
validate_schema_file = metadata.get_data_model_schema_file_name()
layout = array_layout.ArrayLayout(
mongo_db_config=db_config,
model_version=args_dict["model_version"],
site=site,
telescope_list_file=args_dict["input"],
telescope_list_metadata_file=args_dict["input_meta"],
validate=not args_dict["skip_input_validation"],
)
layout.select_assets(args_dict["select_assets"])
layout.convert_coordinates()
if args_dict["export"] is not None:
product_data = (
layout.export_one_telescope_as_json(crs_name=args_dict["export"])
if json_type
else layout.export_telescope_list_table(crs_name=args_dict["export"])
)
writer.ModelDataWriter.dump(
args_dict=args_dict,
metadata=top_level_meta,
product_data=product_data,
validate_schema_file=validate_schema_file,
)
else:
layout.print_telescope_list(
crs_name=args_dict["print"],
)
if __name__ == "__main__":
main()
