Changeset 2771 for trunk/python


Ignore:
Timestamp:
02/13/13 14:43:43 (11 years ago)
Author:
WataruKawasaki
Message:

New Development: No

JIRA Issue: No

Ready for Test: Yes

Interface Changes: No

What Interface Changed:

Test Programs:

Put in Release Notes: No

Module(s): sd.scantable

Description: argument order change in baselining functions: mask at first, and order at second (for poly).


File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/python/scantable.py

    r2767 r2771  
    28892889
    28902890    @asaplog_post_dec
    2891     def sinusoid_baseline(self, insitu=None, mask=None, applyfft=None,
     2891    def sinusoid_baseline(self, mask=None, applyfft=None,
    28922892                          fftmethod=None, fftthresh=None,
    2893                           addwn=None, rejwn=None, clipthresh=None,
    2894                           clipniter=None, plot=None,
    2895                           getresidual=None, showprogress=None,
    2896                           minnrow=None, outlog=None,
     2893                          addwn=None, rejwn=None,
     2894                          insitu=None,
     2895                          clipthresh=None, clipniter=None,
     2896                          plot=None,
     2897                          getresidual=None,
     2898                          showprogress=None, minnrow=None,
     2899                          outlog=None,
    28972900                          blfile=None, csvformat=None,
    28982901                          bltable=None):
     
    29022905
    29032906        Parameters:
    2904             insitu:        if False a new scantable is returned.
    2905                            Otherwise, the scaling is done in-situ
    2906                            The default is taken from .asaprc (False)
    29072907            mask:          an optional mask
    29082908            applyfft:      if True use some method, such as FFT, to find
     
    29362936                           wave numbers which are specified both in addwn
    29372937                           and rejwn will NOT be used. default is [].
     2938            insitu:        if False a new scantable is returned.
     2939                           Otherwise, the scaling is done in-situ
     2940                           The default is taken from .asaprc (False)
    29382941            clipthresh:    Clipping threshold. (default is 3.0, unit: sigma)
    29392942            clipniter:     maximum number of iteration of 'clipthresh'-sigma
     
    29822985                workscan = self.copy()
    29832986           
    2984             #if mask          is None: mask          = [True for i in xrange(workscan.nchan())]
    29852987            if mask          is None: mask          = []
    29862988            if applyfft      is None: applyfft      = True
     
    30343036
    30353037    @asaplog_post_dec
    3036     def auto_sinusoid_baseline(self, insitu=None, mask=None, applyfft=None,
     3038    def auto_sinusoid_baseline(self, mask=None, applyfft=None,
    30373039                               fftmethod=None, fftthresh=None,
    3038                                addwn=None, rejwn=None, clipthresh=None,
    3039                                clipniter=None, edge=None, threshold=None,
    3040                                chan_avg_limit=None, plot=None,
    3041                                getresidual=None, showprogress=None,
    3042                                minnrow=None, outlog=None,
     3040                               addwn=None, rejwn=None,
     3041                               insitu=None,
     3042                               clipthresh=None, clipniter=None,
     3043                               edge=None, threshold=None, chan_avg_limit=None,
     3044                               plot=None,
     3045                               getresidual=None,
     3046                               showprogress=None, minnrow=None,
     3047                               outlog=None,
    30433048                               blfile=None, csvformat=None,
    30443049                               bltable=None):
     
    30503055
    30513056        Parameters:
    3052             insitu:         if False a new scantable is returned.
    3053                             Otherwise, the scaling is done in-situ
    3054                             The default is taken from .asaprc (False)
    30553057            mask:           an optional mask retreived from scantable
    30563058            applyfft:       if True use some method, such as FFT, to find
     
    30843086                            wave numbers which are specified both in addwn
    30853087                            and rejwn will NOT be used. default is [].
     3088            insitu:         if False a new scantable is returned.
     3089                            Otherwise, the scaling is done in-situ
     3090                            The default is taken from .asaprc (False)
    30863091            clipthresh:     Clipping threshold. (default is 3.0, unit: sigma)
    30873092            clipniter:      maximum number of iteration of 'clipthresh'-sigma
     
    31473152                workscan = self.copy()
    31483153           
    3149             #if mask           is None: mask           = [True for i in xrange(workscan.nchan())]
    31503154            if mask           is None: mask           = []
    31513155            if applyfft       is None: applyfft       = True
     
    32003204
    32013205    @asaplog_post_dec
    3202     def cspline_baseline(self, insitu=None, mask=None, npiece=None,
     3206    def cspline_baseline(self, mask=None, npiece=None, insitu=None,
    32033207                         clipthresh=None, clipniter=None, plot=None,
    32043208                         getresidual=None, showprogress=None, minnrow=None,
     
    32103214
    32113215        Parameters:
     3216            mask:         An optional mask
     3217            npiece:       Number of pieces. (default is 2)
    32123218            insitu:       If False a new scantable is returned.
    32133219                          Otherwise, the scaling is done in-situ
    32143220                          The default is taken from .asaprc (False)
    3215             mask:         An optional mask
    3216             npiece:       Number of pieces. (default is 2)
    32173221            clipthresh:   Clipping threshold. (default is 3.0, unit: sigma)
    32183222            clipniter:    maximum number of iteration of 'clipthresh'-sigma
     
    32613265                workscan = self.copy()
    32623266
    3263             #if mask         is None: mask         = [True for i in xrange(workscan.nchan())]
    32643267            if mask         is None: mask         = []
    32653268            if npiece       is None: npiece       = 2
     
    33003303
    33013304    @asaplog_post_dec
    3302     def auto_cspline_baseline(self, insitu=None, mask=None, npiece=None,
     3305    def auto_cspline_baseline(self, mask=None, npiece=None, insitu=None,
    33033306                              clipthresh=None, clipniter=None,
    33043307                              edge=None, threshold=None, chan_avg_limit=None,
     
    33133316
    33143317        Parameters:
     3318            mask:           an optional mask retreived from scantable
     3319            npiece:         Number of pieces. (default is 2)
    33153320            insitu:         if False a new scantable is returned.
    33163321                            Otherwise, the scaling is done in-situ
    33173322                            The default is taken from .asaprc (False)
    3318             mask:           an optional mask retreived from scantable
    3319             npiece:         Number of pieces. (default is 2)
    33203323            clipthresh:     Clipping threshold. (default is 3.0, unit: sigma)
    33213324            clipniter:      maximum number of iteration of 'clipthresh'-sigma
     
    34263429
    34273430    @asaplog_post_dec
    3428     def chebyshev_baseline(self, insitu=None, mask=None, order=None,
     3431    def chebyshev_baseline(self, mask=None, order=None, insitu=None,
    34293432                           clipthresh=None, clipniter=None, plot=None,
    34303433                           getresidual=None, showprogress=None, minnrow=None,
     
    34353438
    34363439        Parameters:
     3440            mask:         An optional mask
     3441            order:        the maximum order of Chebyshev polynomial (default is 5)
    34373442            insitu:       If False a new scantable is returned.
    34383443                          Otherwise, the scaling is done in-situ
    34393444                          The default is taken from .asaprc (False)
    3440             mask:         An optional mask
    3441             order:        the maximum order of Chebyshev polynomial (default is 5)
    34423445            clipthresh:   Clipping threshold. (default is 3.0, unit: sigma)
    34433446            clipniter:    maximum number of iteration of 'clipthresh'-sigma
     
    35243527
    35253528    @asaplog_post_dec
    3526     def auto_chebyshev_baseline(self, insitu=None, mask=None, order=None,
     3529    def auto_chebyshev_baseline(self, mask=None, order=None, insitu=None,
    35273530                              clipthresh=None, clipniter=None,
    35283531                              edge=None, threshold=None, chan_avg_limit=None,
     
    35363539
    35373540        Parameters:
     3541            mask:           an optional mask retreived from scantable
     3542            order:          the maximum order of Chebyshev polynomial (default is 5)
    35383543            insitu:         if False a new scantable is returned.
    35393544                            Otherwise, the scaling is done in-situ
    35403545                            The default is taken from .asaprc (False)
    3541             mask:           an optional mask retreived from scantable
    3542             order:          the maximum order of Chebyshev polynomial (default is 5)
    35433546            clipthresh:     Clipping threshold. (default is 3.0, unit: sigma)
    35443547            clipniter:      maximum number of iteration of 'clipthresh'-sigma
     
    36473650
    36483651    @asaplog_post_dec
    3649     def poly_baseline(self, insitu=None, mask=None, order=None,
     3652    def poly_baseline(self, mask=None, order=None, insitu=None,
    36503653                      clipthresh=None, clipniter=None, plot=None,
    36513654                      getresidual=None, showprogress=None, minnrow=None,
     
    36553658        Return a scan which has been baselined (all rows) by a polynomial.
    36563659        Parameters:
     3660            mask:         an optional mask
     3661            order:        the order of the polynomial (default is 0)
    36573662            insitu:       if False a new scantable is returned.
    36583663                          Otherwise, the scaling is done in-situ
    36593664                          The default is taken from .asaprc (False)
    3660             mask:         an optional mask
    3661             order:        the order of the polynomial (default is 0)
    36623665            clipthresh:   Clipping threshold. (default is 3.0, unit: sigma)
    36633666            clipniter:    maximum number of iteration of 'clipthresh'-sigma
     
    37973800
    37983801    @asaplog_post_dec
    3799     def auto_poly_baseline(self, insitu=None, mask=None, order=None,
     3802    def auto_poly_baseline(self, mask=None, order=None, insitu=None,
    38003803                           clipthresh=None, clipniter=None,
    38013804                           edge=None, threshold=None, chan_avg_limit=None,
     
    38093812
    38103813        Parameters:
     3814            mask:           an optional mask retreived from scantable
     3815            order:          the order of the polynomial (default is 0)
    38113816            insitu:         if False a new scantable is returned.
    38123817                            Otherwise, the scaling is done in-situ
    38133818                            The default is taken from .asaprc (False)
    3814             mask:           an optional mask retreived from scantable
    3815             order:          the order of the polynomial (default is 0)
    38163819            clipthresh:     Clipping threshold. (default is 3.0, unit: sigma)
    38173820            clipniter:      maximum number of iteration of 'clipthresh'-sigma
Note: See TracChangeset for help on using the changeset viewer.