transform module¶
Module for processing, cleaning, and spatially clipping raw crime data.
CrimeDataPackage
dataclass
¶
Wrapper that bundles structured monthly crime data with its target temporal metadata.
Attributes:
| Name | Type | Description |
|---|---|---|
df |
DataFrame
|
The processed pandas DataFrame containing crime records. |
month |
int
|
The numerical month (1-12) associated with the dataset. |
year |
int
|
The four-digit year associated with the dataset. |
Source code in src/geocrime_stl/etl/transform.py
24 25 26 27 28 29 30 31 32 33 34 35 36 | |
clean_and_spatial_clip(df, month, year)
¶
Normalizes features, handles type enforcement, and spatially clips observations.
Normalizes records to St. Louis City limits and returns a populated CrimeDataPackage wrapper.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
df
|
DataFrame
|
The raw pandas DataFrame to be cleaned. |
required |
month
|
int
|
The target month integer. |
required |
year
|
int
|
The target year integer. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
CrimeDataPackage |
CrimeDataPackage
|
A package containing the cleaned, clipped DataFrame and metadata. |
Source code in src/geocrime_stl/etl/transform.py
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 | |
clip_df(df)
¶
Restricts point coordinates to the formal polygon limits of St. Louis City.
Uses an inner spatial join against the city boundary file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
df
|
DataFrame
|
The pandas DataFrame containing latitude and longitude columns. |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
pd.DataFrame: A filtered DataFrame containing only points within city limits. |
Raises:
| Type | Description |
|---|---|
FileNotFoundError
|
If the city boundary configuration file cannot be found. |
Source code in src/geocrime_stl/etl/transform.py
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 184 185 | |
parse_incident_dates(values)
¶
Parse the IncidentDate column, which SLMPD has published in two layouts.
Most monthly files use m/d/YYYY (5/1/2024). The January-April 2024 files use ISO dates
(2024-01-05). The m/d/YYYY layout is tried first, so months that already worked parse
exactly as before; anything it cannot read is then tried as ISO. Values that match neither become NaT.
Source code in src/geocrime_stl/etl/transform.py
58 59 60 61 62 63 64 65 66 67 68 69 70 | |
raw_csv_to_dataframe(csv_bytes, **kwargs)
¶
Converts raw byte stream cleanly into an in-memory Pandas DataFrame.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
csv_bytes
|
bytes
|
The raw byte content of the downloaded CSV file. |
required |
**kwargs
|
Additional keyword arguments passed directly to |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pd.DataFrame: The loaded DataFrame parsed from the byte stream. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the byte stream fails to decode into a valid DataFrame. |
Source code in src/geocrime_stl/etl/transform.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | |
run_pipeline(month, year)
¶
Runs the entire ingestion, cleaning, and spatial-clipping pipeline.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
month
|
int
|
The target month integer to process. |
required |
year
|
int
|
The target year integer to process. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
CrimeDataPackage |
CrimeDataPackage
|
The resulting packaged dataset containing cleaned data and metadata. |
Source code in src/geocrime_stl/etl/transform.py
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 | |