profoundCatMerge: Catalogue Merging Tool

Description

Merges segmentation and grouped segmentation catalogues based on which groups are preferred.

Usage

profoundCatMerge(segstats = NULL, groupstats = NULL, groupsegID = NULL,
groupID_merge = NULL, flag = TRUE, rowreset = FALSE)

Arguments

segstats

Data.frame, segmentation catalogue output from profoundProFound.

groupstats

Data.frame, grouped segmentation catalogue output from profoundProFound.

groupsegID

List; group information as output by profoundSegimGroup or profoundProFound. Must correspond to the supplied segstats and groupstats.

groupID_merge

Integer vector; group IDs that are preferred solutions. All segmented belonging to the corresponding group will be removed, and the new group photometry inserted instead.

flag

Logical; should an extra column be added to the end specifying the origin of the photometry (either 'seg' for the segmentation map, or 'group' for the grouped segmentation map)?

rowreset

Logical; should the data.frame row names be reset to be 1:Nrow of the data.frame? The default leaves a trace of the group segment selection (i.e. you can see the selected row numbers from the provided segstats).

Value

Merged catalogue. This will have the same number of columns as segstats, with an additional column at the end called 'origin' that flags whether the object came from the segmentation catalogue (seg) or grouped segmentation catalogue (group).

Details

Handy tool to robustly merge catalogues based on preferred solutions.

Examples

Run this code

# NOT RUN {
image=readFITS(system.file("extdata", 'VIKING/mystery_VIKING_Z.fits', package="ProFound"))
profound=profoundProFound(image, skycut=1.5, magzero=30, groupstats=TRUE, verbose=TRUE)

merge=profoundCatMerge(profound$segstats, profound$groupstats,
profound$group$groupsegID, 1)

profound$segstats[1,'mag']
merge[1,'mag'] #The merged object is brighter, as we should expect.
# }