Skip to content

lstautorta.paths

Classes:

Name Description
RecoPathStructure

Implements the path structures to store RTA data for LST AUTO RTA

RecoPathStructure

Implements the path structures to store RTA data for LST AUTO RTA

Attributes:

Name Type Description
base_data_dir Path

Directory into which all RTA data are written. A Night's data will be added in sub-directories.
night_date datetime

Date of the observation night. If in the morning, the date modified to correspond to the previous day (day of the start of the night).

Methods:

Name Description
create_night_data_dir

Create the night's data directory
create_observation_data_dirs

Create the observation directory and sub-directories
dl1_dir

Path to the DL1 subdirectory in obs_dir
dl2_dir

Path to the DL2 subdirectory in obs_dir
dl3_dir

Path to the DL3 subdirectory in obs_dir
log_dir

Path to the logs subdirectory in obs_dir
obs_dirs

Get the observation directories with data from observation obs_id
plt_dir

Path to the plot subdirectory in obs_dir
Source code in src/lstautorta/paths.py 
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
class RecoPathStructure:
    """Implements the path structures to store RTA data for LST AUTO RTA

    Attributes
    ----------
    base_data_dir: Path
        Directory into which all RTA data are written. A Night's data will be added in sub-directories.
    night_date: datetime.datetime
        Date of the observation night. If in the morning, the date modified to correspond to the
        previous day (day of the start of the night).
    """

    def __init__(self, base_data_dir: str, night_date: datetime.datetime):
        self.base_data_dir = Path(base_data_dir)
        self.night_date = night_date
        if self.night_date.hour < 12:
            self.night_date = self.night_date - datetime.timedelta(days=1)

    @property
    def night_data_dir(
        self,
    ) -> Path:
        """Path to the night's data directory

        Returns
        -------
        Path
            Path of the night's data directory: base_data_dir/YYYY/MM/DD
        """
        return self.base_data_dir.joinpath(
            f"{self.night_date.year:04d}",
            f"{self.night_date.month:02d}",
            f"{self.night_date.day:02d}",
        )

    def create_night_data_dir(self):
        """Create the night's data directory"""
        self.night_data_dir.mkdir(parents=True, exist_ok=True)

    def _new_obs_dir(self, obs_id: str, ensure_unique: bool = False) -> Path:
        """Get the Path to a new observation directory

        Parameters
        ----------
        obs_id : str
            Observation ID
        ensure_unique : bool, optional
            If true, a suffix is appended to the default name to make sure that the new directory doesn't yet exists, by default False

        Returns
        -------
        Path
            Path to a new observation directory
        """
        obs_data_dir = self.night_data_dir / obs_id
        if ensure_unique:
            suffix_number = 0
            while obs_data_dir.exists():
                obs_data_dir = self.night_data_dir / (obs_id + f"_{suffix_number}")
                suffix_number += 1
        return obs_data_dir

    def dl1_dir(self, obs_dir: Path | str) -> Path:
        """Path to the DL1 subdirectory in `obs_dir`

        Parameters
        ----------
        obs_dir : Path or str
            Path to the observation directory

        Returns
        -------
        Path
            Path to the DL1 sub-directory of `obs_dir`.
        """
        return Path(obs_dir) / "DL1"

    def dl2_dir(self, obs_dir: Path | str) -> Path:
        """Path to the DL2 subdirectory in `obs_dir`

        Parameters
        ----------
        obs_dir : Path or str
            Path to the observation directory

        Returns
        -------
        Path
            Path to the DL2 sub-directory of `obs_dir`
        """
        return Path(obs_dir) / "DL2"

    def dl3_dir(self, obs_dir: Path | str) -> Path:
        """Path to the DL3 subdirectory in `obs_dir`

        Parameters
        ----------
        obs_dir : Path or str
            Path to the observation directory

        Returns
        -------
        Path
            Path to the DL3 sub-directory of `obs_dir`
        """
        return Path(obs_dir) / "DL3"

    def log_dir(self, obs_dir: Path | str) -> Path:
        """Path to the logs subdirectory in `obs_dir`

        Parameters
        ----------
        obs_dir : Path or str
            Path to the observation directory

        Returns
        -------
        Path
            Path to the log sub-directory of `obs_dir`
        """
        return Path(obs_dir) / "logs"

    def plt_dir(self, obs_dir: Path | str) -> Path:
        """Path to the plot subdirectory in `obs_dir`

        Parameters
        ----------
        obs_dir : Path or str
            Path to the observation directory

        Returns
        -------
        Path
            Path to the plot sub-directory of `obs_dir`
        """
        return Path(obs_dir) / "plots"

    def create_observation_data_dirs(self, obs_id: str, ensure_unique: bool = False) -> Path:
        """Create the observation directory and sub-directories

        Parameters
        ----------
        obs_id : str
            Observation ID
        ensure_unique : bool, optional
            If true, makes sure that the created observation directory is unique, otherwise
            an existing repository can be re-used, by default False

        Returns
        -------
        obs_data_dir : Path
            Path of the observation directory.
        """
        obs_data_dir = self._new_obs_dir(obs_id, ensure_unique)
        obs_data_dir.mkdir(parents=True, exist_ok=True)
        self.dl1_dir(obs_data_dir).mkdir(exist_ok=True)
        self.dl2_dir(obs_data_dir).mkdir(exist_ok=True)
        self.dl3_dir(obs_data_dir).mkdir(exist_ok=True)
        self.log_dir(obs_data_dir).mkdir(exist_ok=True)
        self.plt_dir(obs_data_dir).mkdir(exist_ok=True)
        return obs_data_dir

    def obs_dirs(self, obs_id: str) -> list[Path]:
        """Get the observation directories with data from observation `obs_id`

        Since several directories can exists when `ensure_unique = True`, this function
        returns a list of all possible directories for an observation.

        Parameters
        ----------
        obs_id : str
            Observation ID.

        Returns
        -------
        List[Path]
            List of Paths to directories containing data from observation `obs_id`.
        """
        return [d for d in self.night_data_dir.iterdir() if d.is_dir() and d.startswith(obs_id)]

night_data_dir property 

night_data_dir

Path to the night's data directory

Returns:

Type Description
Path

Path of the night's data directory: base_data_dir/YYYY/MM/DD

create_night_data_dir 

create_night_data_dir()

Create the night's data directory

Source code in src/lstautorta/paths.py 
40
41
42
def create_night_data_dir(self):
    """Create the night's data directory"""
    self.night_data_dir.mkdir(parents=True, exist_ok=True)

create_observation_data_dirs 

create_observation_data_dirs(obs_id, ensure_unique=False)

Create the observation directory and sub-directories

Parameters:

Name Type Description Default
obs_id str

Observation ID

 required
ensure_unique bool

If true, makes sure that the created observation directory is unique, otherwise an existing repository can be re-used, by default False

 False

Returns:

Name Type Description
obs_data_dir Path

Path of the observation directory.
Source code in src/lstautorta/paths.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def create_observation_data_dirs(self, obs_id: str, ensure_unique: bool = False) -> Path:
    """Create the observation directory and sub-directories

    Parameters
    ----------
    obs_id : str
        Observation ID
    ensure_unique : bool, optional
        If true, makes sure that the created observation directory is unique, otherwise
        an existing repository can be re-used, by default False

    Returns
    -------
    obs_data_dir : Path
        Path of the observation directory.
    """
    obs_data_dir = self._new_obs_dir(obs_id, ensure_unique)
    obs_data_dir.mkdir(parents=True, exist_ok=True)
    self.dl1_dir(obs_data_dir).mkdir(exist_ok=True)
    self.dl2_dir(obs_data_dir).mkdir(exist_ok=True)
    self.dl3_dir(obs_data_dir).mkdir(exist_ok=True)
    self.log_dir(obs_data_dir).mkdir(exist_ok=True)
    self.plt_dir(obs_data_dir).mkdir(exist_ok=True)
    return obs_data_dir

dl1_dir 

dl1_dir(obs_dir)

Path to the DL1 subdirectory in obs_dir

Parameters:

Name Type Description Default
obs_dir Path or str

Path to the observation directory

 required

Returns:

Type Description
Path

Path to the DL1 sub-directory of obs_dir.
Source code in src/lstautorta/paths.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def dl1_dir(self, obs_dir: Path | str) -> Path:
    """Path to the DL1 subdirectory in `obs_dir`

    Parameters
    ----------
    obs_dir : Path or str
        Path to the observation directory

    Returns
    -------
    Path
        Path to the DL1 sub-directory of `obs_dir`.
    """
    return Path(obs_dir) / "DL1"

dl2_dir 

dl2_dir(obs_dir)

Path to the DL2 subdirectory in obs_dir

Parameters:

Name Type Description Default
obs_dir Path or str

Path to the observation directory

 required

Returns:

Type Description
Path

Path to the DL2 sub-directory of obs_dir
Source code in src/lstautorta/paths.py 
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def dl2_dir(self, obs_dir: Path | str) -> Path:
    """Path to the DL2 subdirectory in `obs_dir`

    Parameters
    ----------
    obs_dir : Path or str
        Path to the observation directory

    Returns
    -------
    Path
        Path to the DL2 sub-directory of `obs_dir`
    """
    return Path(obs_dir) / "DL2"

dl3_dir 

dl3_dir(obs_dir)

Path to the DL3 subdirectory in obs_dir

Parameters:

Name Type Description Default
obs_dir Path or str

Path to the observation directory

 required

Returns:

Type Description
Path

Path to the DL3 sub-directory of obs_dir
Source code in src/lstautorta/paths.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def dl3_dir(self, obs_dir: Path | str) -> Path:
    """Path to the DL3 subdirectory in `obs_dir`

    Parameters
    ----------
    obs_dir : Path or str
        Path to the observation directory

    Returns
    -------
    Path
        Path to the DL3 sub-directory of `obs_dir`
    """
    return Path(obs_dir) / "DL3"

log_dir 

log_dir(obs_dir)

Path to the logs subdirectory in obs_dir

Parameters:

Name Type Description Default
obs_dir Path or str

Path to the observation directory

 required

Returns:

Type Description
Path

Path to the log sub-directory of obs_dir
Source code in src/lstautorta/paths.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def log_dir(self, obs_dir: Path | str) -> Path:
    """Path to the logs subdirectory in `obs_dir`

    Parameters
    ----------
    obs_dir : Path or str
        Path to the observation directory

    Returns
    -------
    Path
        Path to the log sub-directory of `obs_dir`
    """
    return Path(obs_dir) / "logs"

obs_dirs 

obs_dirs(obs_id)

Get the observation directories with data from observation obs_id

Since several directories can exists when ensure_unique = True, this function returns a list of all possible directories for an observation.

Parameters:

Name Type Description Default
obs_id str

Observation ID.

 required

Returns:

Type Description
List[Path]

List of Paths to directories containing data from observation obs_id.
Source code in src/lstautorta/paths.py 
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
def obs_dirs(self, obs_id: str) -> list[Path]:
    """Get the observation directories with data from observation `obs_id`

    Since several directories can exists when `ensure_unique = True`, this function
    returns a list of all possible directories for an observation.

    Parameters
    ----------
    obs_id : str
        Observation ID.

    Returns
    -------
    List[Path]
        List of Paths to directories containing data from observation `obs_id`.
    """
    return [d for d in self.night_data_dir.iterdir() if d.is_dir() and d.startswith(obs_id)]

plt_dir 

plt_dir(obs_dir)

Path to the plot subdirectory in obs_dir

Parameters:

Name Type Description Default
obs_dir Path or str

Path to the observation directory

 required

Returns:

Type Description
Path

Path to the plot sub-directory of obs_dir
Source code in src/lstautorta/paths.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
def plt_dir(self, obs_dir: Path | str) -> Path:
    """Path to the plot subdirectory in `obs_dir`

    Parameters
    ----------
    obs_dir : Path or str
        Path to the observation directory

    Returns
    -------
    Path
        Path to the plot sub-directory of `obs_dir`
    """
    return Path(obs_dir) / "plots"