Skip to content

Commit

Permalink
Clean up comment for nThresholds reflecting changes
Browse files Browse the repository at this point in the history
  • Loading branch information
trevorgerhardt committed Mar 2, 2025
1 parent c18abb0 commit f1a52bd
Showing 1 changed file with 4 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,10 @@ public class GridResultWriter extends BaseResultWriter {
private static final long HEADER_LENGTH_BYTES = 9 * Integer.BYTES;

/**
* The number of thresholds (time or cumulative access) being applied when computing values for each origin.
* The number of values stored per origin cell in an accessibility results grid.
* Note that we're storing only the number of different thresholds, but not the values themselves in the file.
* This means that the files can only be properly interpreted with the metadata from the regional analysis.
* This is an intentional choice to avoid changing the file format, and in any case these files are not expected
* to ever be used separately from an environment where the metadata is available.
* The number of thresholds (time or cumulative access) stored in the grid and used for computing values per origin.
*
* Note: Only the number of thresholds is stored, not their values. Proper interpretation requires threshold values
* from the regional analysis. Storing values would require a file format change.
*/
private final int nThresholds;

Expand Down

0 comments on commit f1a52bd

Please sign in to comment.