Skip to content

Docs: Improve documentation for getSegment* python wrappers #2732

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.

Sign up for GitHub

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

Merged
WhoBrokeTheBuild merged 1 commit into from
Apr 19, 2024
Merged

Docs: Improve documentation for getSegment* python wrappers #2732

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions python/MDSplus/tree.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2305,6 +2305,12 @@ def getSegmentDim(self, idx):
return dim.value

def getSegmentLimits(self, idx):
"""Return the start and end times of a given segment
@param idx: The index of the segment to query. Indexes start with 0.
@type idx: int
@return: A Tuple of (startTime, endTime)
@rtype: Tuple(Data, Data)
"""
start = _dsc.DescriptorXD()._setTree(self.tree)
end = _dsc.DescriptorXD()._setTree(self.tree)
_exc.checkStatus(
Expand All @@ -2318,14 +2324,20 @@ def getSegmentLimits(self, idx):
if start is not None or end is not None:
return (start, end)

def getSegmentList(self, start, end):
start, end = map(_dat.Data, (start, end))
def getSegmentList(self, startTime, endTime):
"""Return a signal composed of the segments from startTime to endTime
@param startTime: The start of the time range of segments to return
@param endTime: The end of the time range of segments to return
@return: Segment dimension
@rtype: Signal
"""
startTime, endTime = map(_dat.Data, (startTime, endTime))
xd = _dsc.DescriptorXD()._setTree(self.tree)
_exc.checkStatus(
_XTreeShr._XTreeGetSegmentList(self.ctx,
self._nid,
_dat.Data.byref(start),
_dat.Data.byref(end),
_dat.Data.byref(startTime),
_dat.Data.byref(endTime),
xd.ref))
return xd.value

Expand Down