#145 closed enhancement (fixed)
psKernel attributes renaming
| Reported by: | Owned by: | Paul Price | |
|---|---|---|---|
| Priority: | low | Milestone: | |
| Component: | PSLib SDRS | Version: | unspecified |
| Severity: | minor | Keywords: | |
| Cc: |
Description
I found the psKernel abit non-intuitive at first, as it had members that a
user wouldn't normally access directly, namely data and kernelRows.
I suggest that they be renamed to p_data & p_kernelRows and moved to the
bottom of the struct as to signify that they are not meant for direct use by
the user (i.e., private to the implementation).
Also, the user would logically use just 'kernel' to access the kernel data, so
maybe that should be called 'data' instead (as to make it more inline with
psImage and psVector naming conventions).
-rdd
Change History (4)
comment:1 by , 22 years ago
| Owner: | changed from to |
|---|
comment:2 by , 22 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
SDRS changed:
/ A convolution kernel */
typedef struct {
psImage *image; /< Kernel data, in the form of an image
int xMin, yMin; /< Most negative indices
int xMax, yMax; /< Most positive indices
float kernel; /< Pointer to the kernel data
float p_kernelRows; /< Pointer to the rows of the kernel data
} psKernel;
comment:3 by , 22 years ago
| Keywords: | VERIFIED added |
|---|
Should be fixed in SDRS-07 and ADD-06 (7 September 2004).
comment:4 by , 22 years ago
| Keywords: | VERIFIED removed |
|---|

the psImage and the float are just different views on the data. the user may
typically choose one or the other depending on circumstance. thus, data is not
private. but the name might be better as 'image' to clarify which type of view
is which.
I agree that kernelRows is not something users would normally use. calling it
p_kernelRows would emphasize this.