Add speedrate parameter for insert() / eject() functions in wiregrid_actuator
#574
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BrianJKoopman
approved these changes
Nov 27, 2023
There was a problem hiding this comment.
Thanks for adding the high_speed args (and for the suggestion @mhasself!)
I know we're pressed for time. I made some small formatting/docstring changes to address a few things:
- Added the method signature overrides to display default args in the docs pages
- Removed duplicate description of the arguments in the
wiregrid_actuator.rstfile -- I left this description where it already existed, but I'm sort of against it there, it's duplicating effort handled by the autodocs, but that's sort of true of the whole section there - Add default to high_speed and tweaked some formatting in speedrate.
hnakata-JP
pushed a commit
that referenced
this pull request
Apr 12, 2024
…regrid_actuator` (#574) * update wiregrid_actuator.rst * add speedrate parameter in insert/eject() in wiregrid_actuator * add high_speed (bool) parameters to insert/eject * Add method signature overrides and format docstrings --------- Co-authored-by: d1ssk <[email protected]> Co-authored-by: Brian Koopman <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add
speedrateargument forinsert()/eject()functions inwiregrid_actuatoragent and set the limitation of the parameter from 0.0 to 5.0.Motivation and Context
The default value of
speedrateis 1.0 and changingspeedrateallows us to do fast inserting or ejecting, which is useful to check the difference between the detector responses with and without the wiregrid. Setting thespeedrateto 5.0, the time duration for each inserting or ejecting would be about 30 sec which is three times shorter than that in default setting (speedrate=1.0).CAUTION!!
speedrate> 1.0 must not be selected if elevation is not 90 deg.How Has This Been Tested?
It was tested in Kyoto using wiregrid.
Types of changes
Checklist: