Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-28323: Make scarlet the default deblender #455

Merged
merged 1 commit into from Jan 28, 2021
Merged

Conversation

fred3m
Copy link
Contributor

@fred3m fred3m commented Jan 27, 2021

No description provided.

@fred3m fred3m changed the title Make scarlet the default deblender DM-28323: Make scarlet the default deblender Jan 27, 2021
Copy link
Contributor

@parejkoj parejkoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two comments about improved documentation.

@@ -2,7 +2,7 @@ description: Multiband
tasks:
detection: lsst.pipe.tasks.multiBand.DetectCoaddSourcesTask
mergeDetections: lsst.pipe.tasks.mergeDetections.MergeDetectionsTask
deblend: lsst.pipe.tasks.deblendCoaddSourcesPipeline.DeblendCoaddSourcesSingleTask
deblend: lsst.pipe.tasks.deblendCoaddSourcesPipeline.DeblendCoaddSourcesMultiTask
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to see these pipelines be more documented. A comment here to the effect of "Use Scarlet for deblending following RFC-745" or something would be useful. DeblendCoaddSourcesMultiTask itself doesn't even have a docstring, so the relationship between this change and scarlet is unclear unless one already knows that "DeblendMulti" means "scarlet".

@@ -353,7 +353,7 @@ class DeblendCoaddSourcesConfig(Config):
doc="Deblend sources separately in each band")
multiBandDeblend = ConfigurableField(target=ScarletDeblendTask,
doc="Deblend sources simultaneously across bands")
simultaneous = Field(dtype=bool, default=False, doc="Simultaneously deblend all bands?")
simultaneous = Field(dtype=bool, default=True, doc="Simultaneously deblend all bands?")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doc for this field needs to say that this used to switch between the singleBandDeblend and multiBandDeblend subtasks listed above.

simultaneous = Field(dtype=bool,
default=True,
doc="Simultaneously deblend all bands? "
"True uses the 'ScarletDeblendTask' while False performs deblending in "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this docstring should just refer to the ConfigurableField names, not what they are default-configured to. You also need () around this docstring, because I'm pretty sure doc= is only being assigned to the first line here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think you need parens around string concatenation. Looks fine to me.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

milo:~ $ python xxx.py 
abcdef
milo:~ $ cat xxx.py
def p(x):
    print(x)

p("abc"
  "def")

Copy link
Contributor

@parejkoj parejkoj Jan 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I never quite figured out when it was and wasn't necessary. I still recommend the docstring change.

@fred3m fred3m merged commit 85b8e57 into master Jan 28, 2021
@fred3m fred3m deleted the tickets/DM-28323 branch January 28, 2021 01:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants